Skip to main content
POST
/
businesses
/
{id}
/
sms_templates
Create an SMS template
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/sms_templates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "message": "<string>",
  "one_off": true,
  "image": "<any>",
  "shorten_urls": true,
  "image_uploads": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "message": "<string>",
  "estimated_sms_segments": 123,
  "estimated_segments": {
    "sms": 123,
    "mms": 123
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the business

Body

application/json
​
name
string
required

The name of the SMS template

​
message
string
required

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

​
one_off
boolean

Whether the SMS template is one-off

​
image
any

The image associated with the SMS template

​
shorten_urls
boolean

Whether to shorten URLs in the SMS template

​
image_uploads
string[]

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

Response

200 - application/json

The created SMSTemplate object

​
id
string
required

The ID of the SMS template

​
name
string
required

The name of the SMS template

​
message
string
required

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

​
estimated_sms_segments
integer
required

The estimated number of SMS segments

​
estimated_segments
object
required

The estimated number of segments of each type. Has keys sms and mms

⌘I