For Existing User

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Request Body Parameters

Components Parameters

Header

Syntax
{ "type": "HEADER", "format": "TEXT", "text": "TEXT",
# Required if TEXT string contains variables
"example": { "header_text": [ "HEADER_TEXT" ] } }

Example
{ "type": "HEADER", "format": "TEXT", "text": "Our {{1}} is on!", "example": { "header_text": [ "Summer Sale" ] } }

Media Headers

Media headers can be an image, video, or a document such as a PDF. All media must be uploaded with the Resumable Upload API. The syntax for defining a media header is the same for all media types.

Syntax

{ "type": "HEADER", "format": "FORMAT", "example": { "header_handle": [ "HEADER_HANDLE" ] } }

Example
{ "type": "HEADER", "format": "IMAGE", "example": { "header_handle": [ " 4::aW..." ] } }

Location Headers

Location headers appear as generic maps at the top of the template and are useful for order tracking, delivery updates, ride hailing pickup/dropoff, locating physical stores, etc. When tapped, the app user's default map app will open and load the specified location. Locations are specified when you send the template using the Cloud API or On-Premises API.

Location headers can only be used in templates categorized as UTILITY or MARKETING. Real-time locations are not supported.

Syntax

{ "type": "HEADER", "format": "LOCATION" }

Example
{ "type": "HEADER", "format": "LOCATION" }

Body

Body components are text-only components and are required by all templates. Templates are limited to one body component.

Syntax
{ "type": "BODY", "text": "TEXT", # Required if TEXT string contains variables "example": { "body_text": [ [ BODY_TEXT ] ] } }

Example
{ "type": "BODY", "text": "Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.", "example": { "body_text": [ [ "the end of August","25OFF","25%" ] ] } }

Footer

Footers are optional text-only components that appear immediately after the body component. Templates are limited to one footer component.

Syntax
{ "type": "FOOTER", "text": "TEXT" }

Example
{ "type": "FOOTER", "text": "Use the buttons below to manage your marketing subscriptions" }

Buttons

Buttons are optional interactive components that perform specific actions when tapped. Templates can have a mixture of up to 10 button components total, although there are limits to individual buttons of the same type as well as combination limits. These limits are described below.

Buttons are defined within a single buttons component object, packed into a single buttons array. For example, this template uses a phone number button and a URL button:

{ "type": "BUTTONS", "buttons": [ { "type": "PHONE_NUMBER", "text": "Call", "pho ne_number": "15550051310" }, { "type": "URL", "text": "Shop Now", "url": "https://www.luckyshrub.com/shop/" } ] }

If a template has more than three buttons, two buttons will appear in the delivered message and the remaining buttons will be replaced with a See all options button. Tapping the See all options button reveals the remaining buttons.

Phone Number Buttons

Phone number buttons call the specified business phone number when tapped by the app user. Templates are limited to one phone number button.

Syntax
{ "type": "PHONE_NUMBER", "text": "TEXT", "phone_number": "PHONE_NUMBER" }

Example
{ "type": "PHONE_NUMBER", "text": "Call", "phone_number": "15550051310" }

URL Buttons

URL buttons load the specified URL in the device's default web browser when tapped by the app user. Templates are limited to two URL buttons.

Syntax
{ "type": "URL", "text": "TEXT", "url": "URL", # Required if URL contains a variable "example": [ "EXAMPLE" ] }

Example
{ "type": "URL", "text": "Shop Now", "url": "https://www.luckyshrub.com/shop?promo={{1}}", "example": [ "summer2023" ] }

Quick Reply Buttons

Quick reply buttons are custom text-only buttons that immediately message you with the specified text string when tapped by the app user. A common use case-case is a button that allows your customer to easily opt-out of any marketing messages.

Templates are limited to 10 quick reply buttons. If using quick reply buttons with other buttons, buttons must be organized into two groups: quick reply buttons and non-quick reply buttons. If grouped incorrectly, the API will return an error indicating an invalid combination.

Examples of valid groupings:

• Quick Reply, Quick Reply
• Quick Reply, Quick Reply, URL, Phone
• URL, Phone, Quick Reply, Quick Reply

Examples of invalid groupings:

• Quick Reply, URL, Quick Reply
• URL, Quick Reply, URL

When using the Cloud API or On-Premises API to send a template that has multiple quick reply buttons, you can use the index property to designate the order in which buttons appear in the template message.

Syntax
{ "type": "QUICK_REPLY", "text": "TEXT" }

Example
{ "type": "QUICK_REPLY", "text": "Unsubscribe from Promos" }

Copy Code Buttons

Copy code buttons copy a text string (defined when the template is sent in a template message) to the device's clipboard when tapped by the app user. Templates are limited to one copy code button.

Syntax
{ "type": "COPY_CODE", "example": "EXAMPLE" }

Example
{ "type": "COPY_CODE", "text": "250FF" }