Sign in
Sms templates

Create an SMS template

post/businesses/{id}/sms_templates

Path parameters

idstring required

The ID of the business

Request body

namestring required

The name of the SMS template

messagestring required

The message of the SMS template. Variables are supported via {{ variableName }}

one_offboolean

Whether the SMS template is one-off

{"stackTrail":"paths:/businesses/{id}/sms_templates:post:requestBody:content:application/json:schema:properties:image","oasType":"schema","type":"unknown","description":"The image associated with the SMS template"}
shorten_urlsboolean

Whether to shorten URLs in the SMS template

image_uploadsstring[]

The image upload IDs you would like to associate with the SMS template

Response

The created SMSTemplate object

idstring required

The ID of the SMS template

namestring required

The name of the SMS template

messagestring required

The message of the SMS template. Variables are supported via {{ variableName }}

estimated_sms_segmentsinteger required

The estimated number of SMS segments

imagestring nullable required

The ID of the image upload

shorten_urlsboolean required

Whether to shorten URLs in the message

Changes

No recorded changes to this endpoint across all 1 revision of this API.