Skip to main content
POST
Create a message template

Authorizations

Authorization
string
header
required

Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...

Path Parameters

id
string
required

Connected account ID (sapi_acc_...)

Body

application/json

Template definition

category
enum<string>

Category is the message category. Marketing intent in a UTILITY template triggers automatic rejection.

Available options:
MARKETING,
UTILITY,
AUTHENTICATION
Example:

"UTILITY"

components
object[]

Components define the template body, optional header, optional footer, and optional buttons. At minimum one BODY component is required.

language
string

Language is the BCP-47 language code (e.g. en_US, fr_FR, pt_BR).

Example:

"en_US"

name
string

Name is the template identifier. Lowercase letters, digits, underscores only; no spaces.

Example:

"order_confirmation"

Response

Created template (initial status)

category
enum<string>
Available options:
AUTHENTICATION,
MARKETING,
UTILITY
Example:

"UTILITY"

id
string
Example:

"1234567890123456"

status
enum<string>
Available options:
APPROVED,
PENDING,
REJECTED
Example:

"PENDING"