Message templates

Return the WhatsApp message templates on this workspace with their approval status.

Lists WhatsApp templates with their status, category and variable placeholders. Use it before sending outside the 24-hour messaging window, when only an APPROVED template will deliver. Read-only. Filter with status, category or whatsapp_phone_number_id.

Save a new template as a local draft, not yet submitted to Meta.

Creates a local draft template record (status PENDING, no Meta id) in this workspace. It is NOT sent to Meta and cannot be used for sending until it is submitted (templates.submit) and approved. Use it to prepare wording. Placeholders must be {{1}}, {{2}} in sequence, and variables must hold one example value per placeholder. Answers 409 when the name and language already exist.

Fetch a single WhatsApp template by id, with its body and variables.

Returns one template including its components, the variables it expects and its approval status. Use it after templates.list to learn exactly which parameters messages.send must supply. Read-only. Answers 404 when the id does not belong to this workspace.

Delete a template locally and at Meta.

Permanently deletes the template. When it was submitted to Meta it is also deleted there (a failure at Meta is ignored and the local record is still removed), and its variable mappings stop applying. Messages already sent are unaffected, but broadcasts or flows that reference it will fail. A deleted name may be blocked from reuse at Meta. Cannot be undone.

Change the content of a draft, pending or rejected template.

Edits the body, header, footer or buttons of a template. Approved templates cannot be edited (400): create a new one with a new name instead. The edit is local only: it does not resubmit to Meta and does not change the approval status, so call templates.submit afterwards when the template has been rejected. Passing no headerType clears the header.

Delivery, read and failure rates for one template.

Returns the quality rating and the delivery, read and failure counts and rates for one template. Use it to judge whether a template performs before reusing it in a broadcast. Read-only. The counts are computed over the template's 100 most recent messages, not its whole history.

Render a template with variable values without sending anything.

Fills a stored template's header, body, footer and buttons with the values you give and returns the final text. Use it to check wording before messages.send or broadcasts.create. Sends nothing and changes nothing. Keys of variableValues are either variable-library ids (templateVariables.list) or the placeholder numbers "1", "2" of the template body.

Check values against the variable library's type rules before sending.

Validates the values you plan to send against the type rules of the named library variables (URL, currency, date and so on) and returns the errors per variable. Use it before messages.send or broadcasts.create. Sends nothing and changes nothing. Answers 404 when any listed variable id does not exist.

Pull the current templates and statuses from every connected WhatsApp account.

Calls Meta for each connected WhatsApp Business account and upserts the local template records: new ones are created, changed statuses updated, and local templates that no longer exist at Meta are removed. Use it when templates.list looks stale after an approval. It sends nothing to customers. Heavy: one Meta call per account.

Send a template to Meta for approval.

Submits the template to Meta for review. Practically irreversible: the template name is registered at Meta, a rejected or deleted name can be blocked from reuse for a period, and approved templates cannot be edited. Use it only when the wording is final (check templates.renderPreview first). Approval arrives later; read the status with templates.get or run templates.sync. Sends nothing to customers.

Send one real WhatsApp message of an approved template to a test number.

Sends a REAL WhatsApp template message, without variable values, to the number you give. It is billed by Meta like any template conversation and cannot be recalled. Use it only to test your own device; to message a customer use messages.send. Only APPROVED templates, and only Indonesian numbers starting with +62, are accepted.

Return the workspace’s saved canned replies with their shortcuts.

Returns the quick replies the team has saved, each with its shortcut and text. Use it to answer in the workspace's own wording instead of inventing a phrasing. Read-only — sending the text is messages.send. Unlike WhatsApp templates these are internal text only, so they are not valid outside the 24-hour window. Paginated: follow meta.pagination.nextCursor until hasMore is false.

Save a new canned reply with a shortcut.

Creates a quick reply that every agent in the workspace can insert in the inbox by typing its shortcut. Writes the reply and sends nothing. Answers 409 when the shortcut is already taken.

Find quick replies matching a typed fragment, as the inbox autocomplete does.

Autocomplete-style search over quick-reply shortcuts and titles. Use it when you have a few words and want the matching canned replies. An empty q returns an empty list. Read-only. For a full filtered listing use quickReplies.list.

Fetch one quick reply by its exact shortcut.

Returns the single quick reply whose shortcut matches exactly. Use it when the team refers to a canned reply by its shortcut. Read-only. Answers 404 when no reply has that shortcut.

Return the Files Center files that can be attached to a quick reply.

Lists the files a quick reply may carry as an attachment, each with the fileCenterFileId to pass to quickReplies.create or quickReplies.update. Read-only. At most 100 files.

Return the categories quick replies are grouped under.

Returns the quick-reply categories with their ids. Use it to pick a categoryId for quickReplies.list, quickReplies.create or quickReplies.update. Read-only.

Permanently remove a quick reply for the whole workspace.

Deletes the quick reply for every agent; its shortcut stops working at once. Cannot be undone. Use it only when the team asked for the reply to go away. Sends nothing. Answers 404 when the id does not exist.

Change the shortcut, title, text, category or attachment of a quick reply.

Updates only the fields you send. Writes the change and sends nothing; agents see the new text the next time they insert it. Answers 409 when the new shortcut is taken and 404 when the id does not exist.

Return the workspace’s reusable template variable library.

Returns the named variables (customer name, tracking link and so on) that template placeholders can be mapped to, with their type and example value, most used first. Use it to find the variable ids that templates.validate and templates.renderPreview expect. Read-only. Paginated: follow meta.pagination.nextCursor until hasMore is false.

Add a named, typed variable to the library.

Creates a reusable variable that template placeholders can be mapped to (templateVariables.saveMappings). Writes one library row and sends nothing. Answers 409 when a variable with that name already exists.

Show which library variable fills each placeholder of one template.

Returns, for one template name, the mapping of each component position (header, body, footer, button) and placeholder index to a library variable, with the variable details. Use it to know which values to supply when sending that template through messages.send or broadcasts.create. Read-only. An unmapped template returns an empty list.

Fetch a single library variable by id.

Returns one variable with its name, type, description, example value and usage count. Read-only. Answers 404 when the id does not belong to this workspace.

Replace the placeholder-to-variable mapping of one template.

Sets which library variable fills each placeholder of the named template. It REPLACES every existing mapping for that template, so send the complete list, and read the current one first with templateVariables.mappings. Sends nothing; later sends and renders of that template use the new mapping. Each position may appear once.