API Reference

Update message template

put
https://message-template-api.omni.chat/v1/templates/

Updates a message template by its id.

A body that changes category or components must leave the merged template coherent:
AUTHENTICATION and its OTP button go together. Switching to or from AUTHENTICATION
therefore sends category and components in the same request; otherwise the API answers
400 AUTHENTICATION_COMPONENTS_MISMATCH before calling Meta.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of an existing template.

Body Params
recommendationAudit
object
boolean
Defaults to false

Saves a valid local DRAFT without sending it to Meta. Submit explicitly later.

string
length between 1 and 128

Tenant scoped idempotency key. Reuse for retries with the same payload; replays return the current saved template. Records do not expire during the pilot.

string

Optional completed evaluation belonging to the same retailer.

appliedSuggestions
array of strings

Applied suggestion IDs; requires evaluationId.

appliedSuggestions
string
required

The message template title.

string
enum
required

The category of the message template (the MessageTemplateType value; the enum name, e.g. AccountUpdate, is rejected).
ACCOUNT_UPDATE is Meta UTILITY. AUTHENTICATION is Meta's one-time passcode (copy code) category:
Meta writes the body, so the components carry no text. See components.

Allowed:
string
required

The language of the message template.
Example en_US, pt_BR.

components
array of objects
required

Array of template components. For standard templates, use HEADER, BODY, FOOTER, and BUTTONS.
For carousel templates, include a BODY component (main text) and a CAROUSEL component with cards.
Note: CAROUSEL is only allowed for MARKETING category templates.

AUTHENTICATION templates take exactly one BODY (no text, optional add_security_recommendation),
at most one FOOTER (only code_expiration_minutes, 1-90) and exactly one BUTTONS with a single
{ "type": "OTP", "otp_type": "COPY_CODE", "text"?: string }. HEADER, media, CAROUSEL, URL buttons
and unknown keys are rejected; otp_type ONE_TAP/ZERO_TAP are not supported. An OTP button in any
other category is rejected.

components*
teams
array of objects
teams
teamGroups
array of objects
teamGroups
user
object
string
enum
Allowed:
string

ID of a message template from a partner.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?