Page text
10 operations.
-
GET
/v1/page-text/catalog -
POST
/v1/page-text/preview -
GET
/v1/account/page-text/{locale} -
PUT
/v1/account/page-text/{locale} -
GET
/v1/brands/{brand_id}/page-text/{locale} -
PUT
/v1/brands/{brand_id}/page-text/{locale} -
GET
/v1/event-types/{event_type_id}/page-text/{locale} -
PUT
/v1/event-types/{event_type_id}/page-text/{locale} -
GET
/v1/routing-forms/{routing_form_id}/page-text/{locale} -
PUT
/v1/routing-forms/{routing_form_id}/page-text/{locale}
GET
/v1/page-text/catalog
The page text an account may change: each overridable key by panel, with its label, length cap, placeholders, whether it may be hidden and its default in every language; and every locked key with the reason it is locked.
- Operation id
getPageTextCatalog- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
account.read - Assistant tool
- No. Not in the first set of tools (decision 0043, point 9).
Answers
200 The catalog. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
languages
|
array of string | yes | |
every_language
|
string | yes | |
panels
|
array of object | yes | |
panels[]
|
object | yes | |
panels[].id
|
string | yes | |
panels[].label
|
string | yes | |
panels[].keys
|
array of object | yes | |
panels[].keys[]
|
object | yes | |
panels[].keys[].key
|
string | yes | |
panels[].keys[].kind
|
string | yes |
page: a page sentence, which keeps exactly its placeholders. email: a line of the visitor's booking emails, set on the account, a brand or an event type. rule: a routing rule's message in another language. An email line and a rule's message may use only the placeholders listed, and have no default.
Values:
page
,
email
,
rule
.
|
panels[].keys[].label
|
string | yes | |
panels[].keys[].max_length
|
integer | yes | |
panels[].keys[].max_lines
|
integer | yes | How many lines the text may have. |
panels[].keys[].hideable
|
boolean | yes | |
panels[].keys[].placeholders
|
array of string | yes | |
panels[].keys[].defaults
|
object | yes | The bundled sentence in each language; empty for an email line or a rule's message. |
panels[].keys[].defaults.en
|
string | yes | |
panels[].keys[].defaults.da
|
string | yes | |
panels[].keys[].defaults.sv
|
string | yes | |
locked
|
array of object | yes | |
locked[]
|
object | yes | |
locked[].key
|
string | yes | |
locked[].reason
|
string | yes |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The request is not valid. |
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 429 | Too many attempts. |
rate_limited
|
POST
/v1/page-text/preview
Resolves a page's sentences in one language with a draft list in place of one scope's stored list, and says what a save of the draft would refuse. Nothing is stored. An event type needs event_types.read too, a routing form routing_forms.read.
- Operation id
previewPageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
account.read - Assistant tool
- No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).
Request body application/json, required
| Field | Type | Required | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | no | The brand, event type or routing form. Left out for the account. Limits: at most 64 characters. |
language
|
string | yes |
The language of the page to preview.
Values:
en
,
da
,
sv
.
|
locale
|
string | yes | Where the draft goes: the language, or *. |
entries
|
array of object | yes | The draft list for this scope and locale, in place of the stored one. Limits: at most 47 items. |
entries[]
|
object | yes | |
entries[].key
|
string | yes | A key of the catalog that is not locked. Limits: 1 to 64 characters. |
entries[].text
|
string | no | The replacement: plain text on one line, within the key's length cap, with exactly the placeholders of the default. No markup, no link. Limits: at most 1000 characters. |
entries[].hidden
|
boolean | no | Only for a block the catalog marks hideable. true hides it; false shows it again where a broader scope hid it. Never together with text. |
entries[].rule_id
|
string | no | On a routing form's list only: the message rule this routingMessage entry belongs to. The rule's own message is its text in the account's default language, so this is for the other languages, one at a time. Limits: pattern ^rtr_[0-9a-z]{26}$. |
Answers
200 The page's sentences. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
language
|
string | yes | |
sentences
|
map of text to object | yes | Every sentence of the page in that language: its text, or hidden. |
sentences{key}
|
object | yes | |
sentences{key}.text
|
string | no | |
sentences{key}.hidden
|
boolean | no |
Values:
true
.
|
issues
|
array of object | yes | What a save of this draft would refuse. Refused entries are left out above. |
issues[]
|
object | yes | |
issues[].path
|
string | yes | |
issues[].message
|
string | yes |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The body is not valid JSON. The request is not valid. |
invalid_json
,
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 404 | Nothing was found there. |
not_found
|
| 415 | Send the body as JSON. |
unsupported_media_type
|
| 429 | Too many attempts. |
rate_limited
|
GET
/v1/account/page-text/{locale}
The account's own page text in one language, or in every language (*).
- Operation id
getAccountPageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
account.read - Assistant tool
- No. Not in the first set of tools (decision 0043, point 9).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
locale
|
path | string | yes | A supported language, or * for every language. |
Answers
200 The list. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | yes | |
locale
|
string | yes | A supported language, or *. |
version
|
integer | yes | The scope's version. Send it back to replace the list. |
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].key
|
string | yes | |
entries[].text
|
string | no | |
entries[].hidden
|
boolean | no | |
entries[].rule_id
|
string | no | The message rule, on a routing form's list. |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The request is not valid. |
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 429 | Too many attempts. |
rate_limited
|
PUT
/v1/account/page-text/{locale}
Replaces the account's own page text in one language, or in every language (*). Send the whole list and the account's version. A locked or unknown key, a text with other placeholders than the default, markup or a link refuses the whole list.
- Operation id
replaceAccountPageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
account.update - Assistant tool
- No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
locale
|
path | string | yes | A supported language, or * for every language. |
Request body application/json, required
| Field | Type | Required | Notes |
|---|---|---|---|
version
|
integer | yes | The scope's version, as read. Limits: at least 1. |
entries
|
array of object | yes | The whole list for this scope and language. A key left out inherits. Limits: at most 47 items. |
entries[]
|
object | yes | |
entries[].key
|
string | yes | A key of the catalog that is not locked. Limits: 1 to 64 characters. |
entries[].text
|
string | no | The replacement: plain text on one line, within the key's length cap, with exactly the placeholders of the default. No markup, no link. Limits: at most 1000 characters. |
entries[].hidden
|
boolean | no | Only for a block the catalog marks hideable. true hides it; false shows it again where a broader scope hid it. Never together with text. |
entries[].rule_id
|
string | no | On a routing form's list only: the message rule this routingMessage entry belongs to. The rule's own message is its text in the account's default language, so this is for the other languages, one at a time. Limits: pattern ^rtr_[0-9a-z]{26}$. |
Answers
200 The list after the change. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | yes | |
locale
|
string | yes | A supported language, or *. |
version
|
integer | yes | The scope's version. Send it back to replace the list. |
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].key
|
string | yes | |
entries[].text
|
string | no | |
entries[].hidden
|
boolean | no | |
entries[].rule_id
|
string | no | The message rule, on a routing form's list. |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The body is not valid JSON. The request is not valid. |
invalid_json
,
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 409 | This was changed by someone else since it was read. |
version_conflict
|
| 415 | Send the body as JSON. |
unsupported_media_type
|
| 429 | Too many attempts. |
rate_limited
|
GET
/v1/brands/{brand_id}/page-text/{locale}
A brand's page text in one language, or in every language (*).
- Operation id
getBrandPageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
account.read - Assistant tool
- No. Not in the first set of tools (decision 0043, point 9).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
brand_id
|
path | string | yes | Limits: pattern ^brd_[0-9a-z]{26}$. |
locale
|
path | string | yes | A supported language, or * for every language. |
Answers
200 The list. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | yes | |
locale
|
string | yes | A supported language, or *. |
version
|
integer | yes | The scope's version. Send it back to replace the list. |
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].key
|
string | yes | |
entries[].text
|
string | no | |
entries[].hidden
|
boolean | no | |
entries[].rule_id
|
string | no | The message rule, on a routing form's list. |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The request is not valid. |
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 404 | Nothing was found there. |
not_found
|
| 429 | Too many attempts. |
rate_limited
|
PUT
/v1/brands/{brand_id}/page-text/{locale}
Replaces a brand's page text in one language, or in every language (*). Send the whole list and the brand's version.
- Operation id
replaceBrandPageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
account.update - Assistant tool
- No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
brand_id
|
path | string | yes | Limits: pattern ^brd_[0-9a-z]{26}$. |
locale
|
path | string | yes | A supported language, or * for every language. |
Request body application/json, required
| Field | Type | Required | Notes |
|---|---|---|---|
version
|
integer | yes | The scope's version, as read. Limits: at least 1. |
entries
|
array of object | yes | The whole list for this scope and language. A key left out inherits. Limits: at most 47 items. |
entries[]
|
object | yes | |
entries[].key
|
string | yes | A key of the catalog that is not locked. Limits: 1 to 64 characters. |
entries[].text
|
string | no | The replacement: plain text on one line, within the key's length cap, with exactly the placeholders of the default. No markup, no link. Limits: at most 1000 characters. |
entries[].hidden
|
boolean | no | Only for a block the catalog marks hideable. true hides it; false shows it again where a broader scope hid it. Never together with text. |
entries[].rule_id
|
string | no | On a routing form's list only: the message rule this routingMessage entry belongs to. The rule's own message is its text in the account's default language, so this is for the other languages, one at a time. Limits: pattern ^rtr_[0-9a-z]{26}$. |
Answers
200 The list after the change. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | yes | |
locale
|
string | yes | A supported language, or *. |
version
|
integer | yes | The scope's version. Send it back to replace the list. |
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].key
|
string | yes | |
entries[].text
|
string | no | |
entries[].hidden
|
boolean | no | |
entries[].rule_id
|
string | no | The message rule, on a routing form's list. |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The body is not valid JSON. The request is not valid. |
invalid_json
,
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 404 | Nothing was found there. |
not_found
|
| 409 | This was changed by someone else since it was read. |
version_conflict
|
| 415 | Send the body as JSON. |
unsupported_media_type
|
| 429 | Too many attempts. |
rate_limited
|
GET
/v1/event-types/{event_type_id}/page-text/{locale}
An event type's page text in one language, or in every language (*).
- Operation id
getEventTypePageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
event_types.read - Assistant tool
- No. Not in the first set of tools (decision 0043, point 9).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
event_type_id
|
path | string | yes | Limits: pattern ^evt_[0-9a-z]{26}$. |
locale
|
path | string | yes | A supported language, or * for every language. |
Answers
200 The list. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | yes | |
locale
|
string | yes | A supported language, or *. |
version
|
integer | yes | The scope's version. Send it back to replace the list. |
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].key
|
string | yes | |
entries[].text
|
string | no | |
entries[].hidden
|
boolean | no | |
entries[].rule_id
|
string | no | The message rule, on a routing form's list. |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The request is not valid. |
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 404 | Nothing was found there. |
not_found
|
| 429 | Too many attempts. |
rate_limited
|
PUT
/v1/event-types/{event_type_id}/page-text/{locale}
Replaces an event type's page text in one language, or in every language (*). Send the whole list and the event type's version. An archived event type is not changed.
- Operation id
replaceEventTypePageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
event_types.manage - Assistant tool
- No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
event_type_id
|
path | string | yes | Limits: pattern ^evt_[0-9a-z]{26}$. |
locale
|
path | string | yes | A supported language, or * for every language. |
Request body application/json, required
| Field | Type | Required | Notes |
|---|---|---|---|
version
|
integer | yes | The scope's version, as read. Limits: at least 1. |
entries
|
array of object | yes | The whole list for this scope and language. A key left out inherits. Limits: at most 47 items. |
entries[]
|
object | yes | |
entries[].key
|
string | yes | A key of the catalog that is not locked. Limits: 1 to 64 characters. |
entries[].text
|
string | no | The replacement: plain text on one line, within the key's length cap, with exactly the placeholders of the default. No markup, no link. Limits: at most 1000 characters. |
entries[].hidden
|
boolean | no | Only for a block the catalog marks hideable. true hides it; false shows it again where a broader scope hid it. Never together with text. |
entries[].rule_id
|
string | no | On a routing form's list only: the message rule this routingMessage entry belongs to. The rule's own message is its text in the account's default language, so this is for the other languages, one at a time. Limits: pattern ^rtr_[0-9a-z]{26}$. |
Answers
200 The list after the change. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | yes | |
locale
|
string | yes | A supported language, or *. |
version
|
integer | yes | The scope's version. Send it back to replace the list. |
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].key
|
string | yes | |
entries[].text
|
string | no | |
entries[].hidden
|
boolean | no | |
entries[].rule_id
|
string | no | The message rule, on a routing form's list. |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The body is not valid JSON. The request is not valid. |
invalid_json
,
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 404 | Nothing was found there. |
not_found
|
| 409 | This was changed by someone else since it was read. |
version_conflict
|
| 415 | Send the body as JSON. |
unsupported_media_type
|
| 429 | Too many attempts. |
rate_limited
|
GET
/v1/routing-forms/{routing_form_id}/page-text/{locale}
A routing form's page text in one language, or in every language (*), with its message rules' messages in that language.
- Operation id
getRoutingFormPageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
routing_forms.read - Assistant tool
- No. Not in the first set of tools (decision 0043, point 9).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
routing_form_id
|
path | string | yes | Limits: pattern ^rtf_[0-9a-z]{26}$. |
locale
|
path | string | yes | A supported language, or * for every language. |
Answers
200 The list. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | yes | |
locale
|
string | yes | A supported language, or *. |
version
|
integer | yes | The scope's version. Send it back to replace the list. |
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].key
|
string | yes | |
entries[].text
|
string | no | |
entries[].hidden
|
boolean | no | |
entries[].rule_id
|
string | no | The message rule, on a routing form's list. |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The request is not valid. |
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 404 | Nothing was found there. |
not_found
|
| 429 | Too many attempts. |
rate_limited
|
PUT
/v1/routing-forms/{routing_form_id}/page-text/{locale}
Replaces a routing form's page text in one language, or in every language (*), together with its message rules' messages in that language (routingMessage entries with a rule_id; never in the account's default language or *). Send the whole list and the routing form's version. An archived routing form is not changed.
- Operation id
replaceRoutingFormPageText- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
routing_forms.manage - Assistant tool
- No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
routing_form_id
|
path | string | yes | Limits: pattern ^rtf_[0-9a-z]{26}$. |
locale
|
path | string | yes | A supported language, or * for every language. |
Request body application/json, required
| Field | Type | Required | Notes |
|---|---|---|---|
version
|
integer | yes | The scope's version, as read. Limits: at least 1. |
entries
|
array of object | yes | The whole list for this scope and language. A key left out inherits. Limits: at most 47 items. |
entries[]
|
object | yes | |
entries[].key
|
string | yes | A key of the catalog that is not locked. Limits: 1 to 64 characters. |
entries[].text
|
string | no | The replacement: plain text on one line, within the key's length cap, with exactly the placeholders of the default. No markup, no link. Limits: at most 1000 characters. |
entries[].hidden
|
boolean | no | Only for a block the catalog marks hideable. true hides it; false shows it again where a broader scope hid it. Never together with text. |
entries[].rule_id
|
string | no | On a routing form's list only: the message rule this routingMessage entry belongs to. The rule's own message is its text in the account's default language, so this is for the other languages, one at a time. Limits: pattern ^rtr_[0-9a-z]{26}$. |
Answers
200 The list after the change. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
scope_type
|
string | yes |
Values:
account
,
brand
,
event_type
,
routing_form
.
|
scope_id
|
string | yes | |
locale
|
string | yes | A supported language, or *. |
version
|
integer | yes | The scope's version. Send it back to replace the list. |
entries
|
array of object | yes | |
entries[]
|
object | yes | |
entries[].key
|
string | yes | |
entries[].text
|
string | no | |
entries[].hidden
|
boolean | no | |
entries[].rule_id
|
string | no | The message rule, on a routing form's list. |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The body is not valid JSON. The request is not valid. |
invalid_json
,
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 404 | Nothing was found there. |
not_found
|
| 409 | This was changed by someone else since it was read. |
version_conflict
|
| 415 | Send the body as JSON. |
unsupported_media_type
|
| 429 | Too many attempts. |
rate_limited
|