API reference

Templates API

Author, clone, render, approve, and send message templates. This is the core loop: find or write a template, render it to check the payload and its SMS fallback, submit it for provider approval, then broadcast it.

GET/templatestemplates:read

Search the library

Discover templates by query, channel, and category. Sort by rating or by most-cloned.

Arguments

Name	Type	In	Description
`q`	string	query	Free-text search over name + description.
`category`	string	query	MarketplaceCategory key, e.g. EVENTS.
`channel`	string	query	—RCS \| WHATSAPP \| SMS
`sort`	string	query	—rating \| useddefault: rating
`page`	number	query	—
`pageSize`	number	query	—

Request

curl -X GET "https://your-server/api/agent/templates" \
  -H "Authorization: Bearer $WA_AGENT_KEY"

Same call, as a tool

# MCP tool name
search_templates

# CLI (planned)
$ wa search [query] [--channel WHATSAPP] [--category KEY]

GET/templates/:idtemplates:read

Fetch one template

Fetch one template — content, channel, ratings, clone count, and (where shared) its grounding knowledge doc.

Arguments

Name	Type	In	Description
`id`required	string	path	—

Request

curl -X GET "https://your-server/api/agent/templates/<id>" \
  -H "Authorization: Bearer $WA_AGENT_KEY"

Same call, as a tool

# MCP tool name
get_template

# CLI (planned)
$ wa get <id>

POST/templates/:id/rendertemplates:read

Render + validate

Try before you send: render with sample variables and inspect the validated rich payload plus the mandatory SMS fallback.

Arguments

Name	Type	In	Description
`id`required	string	path	—
`variables`	object	body	Merge fields ({{key}} -> value) to bind into the preview.

Request

curl -X POST "https://your-server/api/agent/templates/<id>/render" \
  -H "Authorization: Bearer $WA_AGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "variables": <object>
  }'

Same call, as a tool

# MCP tool name
render_template

# CLI (planned)
$ wa render <id> [--var key=value ...]

POST/templatestemplates:write

Create a draft

Author a new template from a content object. The shared validator rejects anything that breaks channel rules with machine-coded errors.

Arguments

Name	Type	In	Description
`name`required	string	body	—
`description`	string	body	—
`channel`	string	body	—RCS \| WHATSAPP \| SMS
`category`	string	body	—MARKETING \| UTILITY \| AUTHENTICATION
`content`required	object	body	TemplateContent. Must include a non-empty smsFallback. One of text/card/carousel is the primary body.
`tags`	string[]	body	—

Request

curl -X POST "https://your-server/api/agent/templates" \
  -H "Authorization: Bearer $WA_AGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": <string>,
    "content": <object>
  }'

Same call, as a tool

# MCP tool name
create_template

# CLI (planned)
$ wa create --file <template.json>

PUT/templates/:idtemplates:write

Update a draft

Revise a draft in place, re-running the same validator that gates creation.

Arguments

Name	Type	In	Description
`id`required	string	path	—
`name`	string	body	—
`description`	string	body	—
`channel`	string	body	Move the template to another channel. Requires the matching add-on brand; omit to leave it where it is.RCS \| WHATSAPP
`category`	string	body	—MARKETING \| UTILITY \| AUTHENTICATION
`content`	object	body	Full replacement TemplateContent (not a deep merge). Must include a non-empty smsFallback.
`tags`	string[]	body	—
`knowledgeDoc`	string	body	—

Request

curl -X PUT "https://your-server/api/agent/templates/<id>" \
  -H "Authorization: Bearer $WA_AGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": <string>,
    "description": <string>,
    "channel": <string>,
    "category": <string>,
    "content": <object>,
    "tags": <string[]>,
    "knowledgeDoc": <string>
  }'

Same call, as a tool

# MCP tool name
update_template

# No CLI command for this call yet —
# use the HTTP route or the MCP tool.

POST/templates/:id/duplicatetemplates:write

Fork your own template

Fork one of your own templates into a fresh draft — the in-org counterpart to cloning from the marketplace.

Arguments

Name	Type	In	Description
`id`required	string	path	—

Request

curl -X POST "https://your-server/api/agent/templates/<id>/duplicate" \
  -H "Authorization: Bearer $WA_AGENT_KEY"

Same call, as a tool

# MCP tool name
duplicate_template

# No CLI command for this call yet —
# use the HTTP route or the MCP tool.

DELETE/templates/:idtemplates:write

Delete a template

Remove a template you own from the org.

Arguments

Name	Type	In	Description
`id`required	string	path	—

Request

curl -X DELETE "https://your-server/api/agent/templates/<id>" \
  -H "Authorization: Bearer $WA_AGENT_KEY"

Same call, as a tool

# MCP tool name
delete_template

# No CLI command for this call yet —
# use the HTTP route or the MCP tool.

POST/marketplace/:id/clonemarketplace:clone

Clone into your org

Deep-copy a marketplace listing into your org as a clean private draft you fully own — no provenance carried over.

Arguments

Name	Type	In	Description
`id`required	string	path	—

Request

curl -X POST "https://your-server/api/agent/marketplace/<id>/clone" \
  -H "Authorization: Bearer $WA_AGENT_KEY"

Same call, as a tool

# MCP tool name
clone_template

# CLI (planned)
$ wa clone <id>

POST/templates/:id/submittemplates:submit

Submit for approval

Send a draft to the provider for brand approval and read back its approval status. Until it is approved, sends fall back to SMS.

Arguments

Name	Type	In	Description
`id`required	string	path	—

Request

curl -X POST "https://your-server/api/agent/templates/<id>/submit" \
  -H "Authorization: Bearer $WA_AGENT_KEY"

Same call, as a tool

# MCP tool name
submit_template

# CLI (planned)
$ wa submit <id>

POST/messages/sendmessages:send

Broadcast to recipients

Broadcast an org-owned template to an E.164 list — rich-first, with the always-on SMS/MMS fallback. Returns the delivery funnel, including how many recipients fell back.

Arguments

Name	Type	In	Description
`blueprintId`required	string	body	—
`to`required	string[]	body	—
`variables`	object	body	—
`name`	string	body	—

Request

curl -X POST "https://your-server/api/agent/messages/send" \
  -H "Authorization: Bearer $WA_AGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "blueprintId": <string>,
    "to": <string[]>
  }'

Same call, as a tool

# MCP tool name
send_message

# CLI (planned)
$ wa send <blueprintId> --to +1555... [--var key=value ...]