Skip to main content
POST
Create a template

Authorizations

Authorization
string
header
required

HTTP Basic where username is your account e-mail and password is your security token.

Body

sender_id
integer
required
name
string
required

Normalized server-side (lowercased, spaces become underscores, invalid characters and leading digits stripped) and prefixed with user{id}_. The response returns the final name and your original text as display_name.

body_text
string
required

May contain {{1}}, {{2}} placeholders. A sender-identification footer is automatically appended, adding the reserved variables {{sender_name}}, {{sender_doc}} and {{sender_phone}} (substituted at send time).

category
enum<string>
default:UTILITY
Available options:
UTILITY,
MARKETING,
AUTHENTICATION
language
string
default:pt_BR
header_text
string
header_format
enum<string>
default:NONE
Available options:
NONE,
TEXT,
IMAGE,
DOCUMENT
header_media
file

For IMAGE/DOCUMENT headers. When no media is provided, a default Escrybe sample file is submitted to Meta for approval.

header_media_base64
string
header_media_url
string
header_media_filename
string
variable_examples
string[]

Examples for Meta approval. Auto-filled from your profile when omitted.

Response

Created and submitted (the envelope's code field reads 201)

Envelope used by the WhatsApp template endpoints and template sync.

code
integer
Example:

200

status
string
Example:

"success"

message
string | null
data
object
request_id
string