Account tools
On this page
Most tools take business_id: the business the call is for. talemo_list_businesses names the businesses this connection works in. A tool that changes something also takes dry_run; with it nothing changes, and the answer shows what the change would be, or the refusal it would get.
talemo_close_branch
Close a branch
Close a branch: it leaves the list of open branches and can be opened again at any time with talemo_reopen_branch; nothing of it is deleted. The last open branch of a business is refused with status 409, code branch.last. Closing a closed branch returns it as it is.
Guide: account/organisation-business-branch.
- Changes data
- The same call twice gives the same result
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
branch_id | string | required | Branch ID: talemo_get_business lists the branches of a business. |
business_id | string | required | Business ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden. |
dry_run | boolean | optional | True — change nothing and answer the branch as it would be; what the change would be refused with is refused the same way. |
Described in: Organization, business and branch
talemo_create_branch
Add a branch
Add a branch to a business: another location with its own time zone, address and currency of prices. Without a currency the branch takes no prices: ask the person which one, and offer the usual one of the time zone. A time zone that is not an IANA name, like an offset such as +03:00, is refused with time_zone.invalid; a currency that is not an ISO 4217 code in use, with request.body_invalid.
Guide: account/organisation-business-branch.
- Changes data
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
address | string | optional | Street address as people write it, up to 300 characters. |
business_id | string | required | Business ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden. |
currency | string | optional | Currency of the prices of the branch, an ISO 4217 code like RUB or EUR. Left out — chosen later; the branch has no prices until then. Ask the person before passing it; the usual one of its time zone is the likely answer. |
dry_run | boolean | optional | True — add nothing and answer the branch as it would be. |
name | string | required | Name of the branch, 1 to 120 characters: usually its street or area. |
time_zone | string | required | IANA time zone of the branch, for example Europe/Berlin; never an offset. The times of the branch are read and said in this zone. |
Described in: Organization, business and branch
talemo_get_agent_grant
See what the online admin may do
Show what the online admin of the business may do: what its template declares, which of it the business granted and where, what it always asks a person about first, its daily spending limit — daily_usd in dollars, beside daily_credits, a credit being one cent —, and who granted it and when. Without a grant it answers nobody. Granting is done by a person in Talemo.
Guide: account/team-and-roles.
- Reads only, changes nothing
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
business_id | string | required | Business ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden. |
key | string | required | The agent: online_admin, the participant that answers clients in the business channels by itself. |
Described in: Built-in agents, Explaining the online admin to a salon owner, Onboarding a new business, Team and roles
talemo_get_business
See the business
Show a business: its name, the organization that pays for it, the languages it serves clients in (service_languages, the first is the language its texts are written in) and its branches with their IDs, time zones and addresses. A closed branch has closed_at; every business keeps at least one open branch.
Guide: account/organisation-business-branch.
- Reads only, changes nothing
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
business_id | string | required | Business ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden. |
Described in: Organization, business and branch, Service languages
talemo_reopen_branch
Reopen a branch
Open a closed branch again. Opening an open branch returns it as it is. An unknown branch is refused with not_found.
Guide: account/organisation-business-branch.
- Changes data
- The same call twice gives the same result
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
branch_id | string | required | Branch ID: talemo_get_business lists the branches of a business. |
business_id | string | required | Business ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden. |
dry_run | boolean | optional | True — change nothing and answer the branch as it would be; what the change would be refused with is refused the same way. |
Described in: Organization, business and branch
talemo_update_branch
Change a branch
Change the name, time zone, address or currency of prices of a branch. Fields left out stay as they are. A new currency keeps the numbers of the prices — 2600 RUB becomes 2600 EUR, nothing is converted — so tell the person first. A new time zone moves the schedules of the resources from today on: the same wall-clock hours in the new zone; if bookings would fall outside them, status 409, code schedule.has_bookings — dry_run shows them first. An unknown branch is refused with not_found.
Guide: account/organisation-business-branch.
- Changes data
- May overwrite or remove existing data
- The same call twice gives the same result
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
address | string | optional | New street address; an empty string removes it. Left out — stays. |
branch_id | string | required | Branch ID: talemo_get_business lists the branches of a business. |
business_id | string | required | Business ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden. |
currency | string | optional | Currency of the prices of the branch, an ISO 4217 code like RUB or EUR. It can be changed but not removed; the numbers of the prices stay the same, nothing is converted. Left out — stays. |
dry_run | boolean | optional | True — change nothing and tell what a new time zone would do to the schedules of the resources and which bookings would fall outside them. |
name | string | optional | New name, 1 to 120 characters. Left out — stays as it is. |
phone | string | optional | Phone of the branch that clients call. With + the country code decides the country; without it pass phone_country. An empty string removes it. Left out — stays. |
phone_country | string | optional | Country of a phone written without +, an ISO 3166-1 code like RU or DE. |
time_zone | string | optional | New IANA time zone, for example Europe/Lisbon. Left out — stays. |
Described in: Onboarding a new business, Organization, business and branch, Services, prices and currency
talemo_update_business
Rename the business
Rename a business. Returns the business as it is now.
Guide: account/organisation-business-branch.
- Changes data
- May overwrite or remove existing data
- The same call twice gives the same result
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
business_id | string | required | Business ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden. |
dry_run | boolean | optional | True — change nothing and answer the business as it would be. |
name | string | required | The new name of the business, 1 to 120 characters. |
Described in: Organization, business and branch