Version 2 endpoints for managing message templates. Recommended version for all users. Includes strongly typed translations
field (allowing for message definition using JSON structures also used in the send message request of the Conversation API), improved validation, and the ability to override omni-channel templates in favor of channel-specific templates (where available).
A successful response.
An unexpected error response.
{- "templates": [
- {
- "id": "id_string",
- "description": "Template description",
- "version": 1,
- "default_translation": "en-US",
- "translations": [
- {
- "text_message": {
- "text": "string"
}, - "language_code": "Translation description",
- "version": "1",
- "channel_template_overrides": {
- "WHATSAPP": {
- "template_reference": {
- "language_code": null,
- "parameters": { },
- "template_id": null,
- "version": null
}, - "parameter_mappings": {
- "name": null
}
}, - "KAKAOTALK": {
- "template_reference": {
- "language_code": null,
- "parameters": { },
- "template_id": null,
- "version": null
}, - "parameter_mappings": {
- "name": null
}
}
}, - "variables": [
- {
- "key": "string",
- "preview_value": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
]
}
Required. The template to create.
default_translation required | string The default translation to use if not specified.
Specified as a BCP-47 |
required | Array of Text (object) or Card (object) or Carousel (object) or Choice (object) or Location (object) or Media (object) or Template Message (object) or List (object) (v2TemplateTranslation) |
description | string The description of the template. |
version | integer The version of the template. While creating a template, this will be defaulted to 1. When updating a template, you must supply the latest version of the template in order for the update to be successful. |
create_time | string <date-time> Timestamp when the template was created. |
update_time | string <date-time> Timestamp when the template was updated. |
A successful response.
id | string The id of the template. Specify this yourself during creation. Otherwise, we will generate an ID for you. This must be unique for a given project. |
description | string The description of the template. |
version | integer The version of the template. While creating a template, this will be defaulted to 1. When updating a template, you must supply the latest version of the template in order for the update to be successful. |
default_translation | string The default translation to use if translation not specified.
Specified as a BCP-47 |
Array of Text (object) or Card (object) or Carousel (object) or Choice (object) or Location (object) or Media (object) or Template Message (object) or List (object) (v2TemplateTranslationResponse) | |
create_time | string <date-time> Timestamp when the template was created. |
update_time | string <date-time> Timestamp when the template was updated. |
An unexpected error response.
{- "description": "English text template with one parameter using Conversation API generic format.",
- "default_translation": "en-US",
- "translations": [
- {
- "language_code": "en-US",
- "version": "1",
- "variables": [
- {
- "key": "name",
- "preview_value": "Mr Jones"
}
], - "text_message": {
- "text": "Hi ${name}"
}, - "channel_template_overrides": {
- "WHATSAPP": {
- "template_reference": {
- "template_id": "<referenced template id>",
- "version": 1,
- "language_code": "en-US",
- "parameters": {
- "body[1]text": "defaultValue"
}
}, - "parameter_mappings": {
- "body[1]text": "name"
}
}
}
}
]
}
{- "id": "id_string",
- "description": "Template description",
- "version": 1,
- "default_translation": "en-US",
- "translations": [
- {
- "text_message": {
- "text": "string"
}, - "language_code": "Translation description",
- "version": "1",
- "channel_template_overrides": {
- "WHATSAPP": {
- "template_reference": {
- "language_code": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "template_id": "string",
- "version": "string"
}, - "parameter_mappings": {
- "name": "body[1]text"
}
}, - "KAKAOTALK": {
- "template_reference": {
- "language_code": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "template_id": "string",
- "version": "string"
}, - "parameter_mappings": {
- "name": "body[1]text"
}
}
}, - "variables": [
- {
- "key": "string",
- "preview_value": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
A successful response.
Array of Text (object) or Card (object) or Carousel (object) or Choice (object) or Location (object) or Media (object) or Template Message (object) or List (object) (v2TemplateTranslationResponse) | |||||||||||||||
Array One of: A message containing only text.
|
An unexpected error response.
{- "translations": [
- {
- "text_message": {
- "text": "string"
}, - "language_code": "Translation description",
- "version": "1",
- "channel_template_overrides": {
- "WHATSAPP": {
- "template_reference": {
- "language_code": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "template_id": "string",
- "version": "string"
}, - "parameter_mappings": {
- "name": "body[1]text"
}
}, - "KAKAOTALK": {
- "template_reference": {
- "language_code": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "template_id": "string",
- "version": "string"
}, - "parameter_mappings": {
- "name": "body[1]text"
}
}
}, - "variables": [
- {
- "key": "string",
- "preview_value": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
]
}
Required. The updated template.
version required | integer The version of the template. While creating a template, this will be defaulted to 1. When updating a template, you must supply the latest version of the template in order for the update to be successful. |
description | string The description of the template. |
default_translation | string The default translation to use if not specified.
Specified as a BCP-47 |
Array of Text (object) or Card (object) or Carousel (object) or Choice (object) or Location (object) or Media (object) or Template Message (object) or List (object) (v2TemplateTranslation) | |
create_time | string <date-time> Timestamp when the template was created. |
update_time | string <date-time> Timestamp when the template was updated. |
A successful response.
id | string The id of the template. Specify this yourself during creation. Otherwise, we will generate an ID for you. This must be unique for a given project. |
description | string The description of the template. |
version | integer The version of the template. While creating a template, this will be defaulted to 1. When updating a template, you must supply the latest version of the template in order for the update to be successful. |
default_translation | string The default translation to use if translation not specified.
Specified as a BCP-47 |
Array of Text (object) or Card (object) or Carousel (object) or Choice (object) or Location (object) or Media (object) or Template Message (object) or List (object) (v2TemplateTranslationResponse) | |
create_time | string <date-time> Timestamp when the template was created. |
update_time | string <date-time> Timestamp when the template was updated. |
An unexpected error response.
{- "id": "<template id>",
- "description": "English text template with one parameter using Conversation API generic format.",
- "version": 1,
- "default_translation": "en-US",
- "translations": [
- {
- "language_code": "en-US",
- "version": "1",
- "variables": [
- {
- "key": "name",
- "preview_value": "Mr Jones"
}
], - "text_message": {
- "text": "Hi ${name}"
}, - "channel_template_overrides": {
- "WHATSAPP": {
- "template_reference": {
- "template_id": "<referenced template id>",
- "version": 1,
- "language_code": "en-US",
- "parameters": {
- "body[1]text": "defaultValue"
}
}, - "parameter_mappings": {
- "body[1]text": "name"
}
}
}
}
]
}
{- "id": "id_string",
- "description": "Template description",
- "version": 1,
- "default_translation": "en-US",
- "translations": [
- {
- "text_message": {
- "text": "string"
}, - "language_code": "Translation description",
- "version": "1",
- "channel_template_overrides": {
- "WHATSAPP": {
- "template_reference": {
- "language_code": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "template_id": "string",
- "version": "string"
}, - "parameter_mappings": {
- "name": "body[1]text"
}
}, - "KAKAOTALK": {
- "template_reference": {
- "language_code": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "template_id": "string",
- "version": "string"
}, - "parameter_mappings": {
- "name": "body[1]text"
}
}
}, - "variables": [
- {
- "key": "string",
- "preview_value": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
A successful response.
id | string The id of the template. Specify this yourself during creation. Otherwise, we will generate an ID for you. This must be unique for a given project. |
description | string The description of the template. |
version | integer The version of the template. While creating a template, this will be defaulted to 1. When updating a template, you must supply the latest version of the template in order for the update to be successful. |
default_translation | string The default translation to use if translation not specified.
Specified as a BCP-47 |
Array of Text (object) or Card (object) or Carousel (object) or Choice (object) or Location (object) or Media (object) or Template Message (object) or List (object) (v2TemplateTranslationResponse) | |
create_time | string <date-time> Timestamp when the template was created. |
update_time | string <date-time> Timestamp when the template was updated. |
An unexpected error response.
{- "id": "id_string",
- "description": "Template description",
- "version": 1,
- "default_translation": "en-US",
- "translations": [
- {
- "text_message": {
- "text": "string"
}, - "language_code": "Translation description",
- "version": "1",
- "channel_template_overrides": {
- "WHATSAPP": {
- "template_reference": {
- "language_code": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "template_id": "string",
- "version": "string"
}, - "parameter_mappings": {
- "name": "body[1]text"
}
}, - "KAKAOTALK": {
- "template_reference": {
- "language_code": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "template_id": "string",
- "version": "string"
}, - "parameter_mappings": {
- "name": "body[1]text"
}
}
}, - "variables": [
- {
- "key": "string",
- "preview_value": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}