Skip to main content
POST
Create / update / submit / sync / send / delete WhatsApp templates

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Body

application/json
action
enum<string>
default:create
Available options:
create,
update,
submit,
sync,
send,
delete
connector_id
string<uuid>
id
string<uuid>
template_id
string<uuid>
name
string
body_text
string

Template body. Variables must use positive contiguous numbering: {{1}}, {{2}}, {{3}}.

library_template_name
string

Official library preset name. When supplied with action=create, the preset is created directly for the sender.

library_button_values
object

Button index to HTTPS URL or E.164 phone number. Required for official library templates with URL or phone-number buttons.

language
string
category
enum<string>
Available options:
UTILITY,
MARKETING,
AUTHENTICATION
parameter_bindings
object

Maps component positions (1, 2, header.1) to system, lead, assistant, or custom variable keys.

components
object[]

Meta template components. Call-permission templates use a BODY plus a CALL_PERMISSION_REQUEST component.

to_number
string
context
object

Response

Action result.