Message

List WhatsApp templates

GET/api/v1/whatsapp/templates

Lists the message templates of an official WhatsApp channel (360dialog / Meta), with each template's status and the variables to fill when sending it with Send message โ†’ whatsappTemplate.

  • Only APPROVED templates can be sent.
  • variables lists the body placeholders in order: "1", "2" for positional placeholders, or names such as first_name for named ones. Send a value for each.
  • QR-linked WhatsApp numbers have no templates.

Errors

  • 400: the channel isn't an official WhatsApp channel, has no API key yet (reconnect it), or 360dialog couldn't be reached.
  • 404: the channel wasn't found.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Query Params
  • channelIdstringrequired

    ID of the official WhatsApp channel (uuid). Find it with the Channel endpoints.

Responses

200

OK

  • statusintegerrequired
  • bodyobjectrequired
    Child attributes
    • requestIdstringrequired
    • dataarray[object]required
      Child attributes
      • namestringoptional
      • languagestringoptional
      • categorystringoptional
      • statusstringoptional
      • componentsarray[object]optional
        Child attributes
        • typestringoptional
        • textstringoptional
      • variablesarray[string]optional