KUkudosity
WhatsApp

List WhatsApp templates (Beta)

Changed on

Beta — this endpoint may change before general availability.

Retrieves the WhatsApp templates registered on your account, with their full content, so you can choose a template to send and show its content in your own tools.

Templates are returned newest first. Templates in every status are returned; only APPROVED templates can be sent.

Filtering:

  • All filters are exact matches, and they combine: a template must match every filter you supply.

Pagination:

  • Page-based. Use page and limit, and meta.pagination.total_count to work out the number of pages.
get/v2/whatsapp/templates

Request

  • Base URL
    https://api.transmitmessage.com
  • Auth
    API key in header x-api-key

Query parameters

pageinteger

Page number to return (1-based). Default 1. A page past the last one returns an empty list.

limitinteger

Maximum number of templates to return per page. Default 25. Values over 100 are treated as 100.

status'PENDING' | 'APPROVED' | 'REJECTED' | 'PAUSED' | 'DISABLED' | 'FLAGGED' | 'LOCKED' | 'ARCHIVED' | 'IN_APPEAL' | 'LIMIT_EXCEEDED'

Return only templates with this status. See the status field for what each value means.

category'MARKETING' | 'UTILITY' | 'AUTHENTICATION'

Return only templates in this category.

languagestring

Return only templates in this language, such as en or en_US.

namestring

Return only templates with this exact name. A name that matches no template returns an empty list.

Response

OK

requestobject

Optional metadata (e.g. requestId, traceId)

Example response

{
  "data": {
    "templates": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "spring_sale",
        "language": "en_US",
        "status": "APPROVED",
        "category": "MARKETING",
        "parameter_format": "POSITIONAL"
      }
    ]
  },
  "meta": {
    "pagination": {
      "type": "page",
      "page": 1,
      "limit": 25,
      "total_count": 123
    }
  }
}

Changes