Skip to content

Templates

Templates are the messages you may send at any time, even when the customer has not written in the last 24 hours.

These examples use a placeholder address. Your console shows the exact address of the API for your workspace.

GET /connections/{id}/templates

Lists the message templates of a connection. The list is not paginated.

  • A live key reads the templates from WhatsApp, so the call can answer 503 service_unavailable when WhatsApp is unavailable. Template reads are limited to 10 per minute per key.
  • A sandbox key returns the two fixed sandbox templates.
Required scope
templates.read
HTTP
Success: HTTP 200

Parameters

Parameters
NameDescription
id

string (UUID)
Path · Required

The id of the connection.
status

string (default APPROVED, or all)
Query · Optional

APPROVED by default. Use all to list every status.

Errors

Any authenticated endpoint can also return the authentication, scope and rate limit errors listed on the errors page.

Request

curl "https://api.vendrix.net/v1/connections/6f0a3b1c-9d2e-4f50-8a71-3c5e7d9b1a24/templates" \
  -H "Authorization: Bearer $VENDRIX_API_KEY"

Response

200 OK
{
  "data": [
    {
      "object": "template",
      "name": "order_confirmation",
      "language": "fr",
      "category": "UTILITY",
      "status": "APPROVED",
      "variable_count": 2,
      "body_only": true
    }
  ],
  "next_cursor": null
}