whatsapp

Create a WhatsApp template

Changed on

Creates a WhatsApp message template and returns the template UUID. The template name must not contain upper-case letters or special characters.

The template can be created either from a flat body text (data), or from structured components (header, body, footer, buttons, variables). data is required unless components contains a BODY component. When components is omitted, the template is created with a single BODY built from data.

Permission: Access is managed by the WhatsApp service. No specific API token permission is checked.

Monitoring: No impact.

post/whatsapp/templates

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/whatsapp/templates
  • Auth
    API key in header Authorization

Request body

namestring required
account_uuidstring required
datastring

Template body text. Required unless components contains a BODY component.

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

Meta template category. Defaults to MARKETING when omitted on creation.

Example request

{
  "name": "hello",
  "account_uuid": "1eb09f33-348e-42e6-bfb3-361df133c82e",
  "data": "Hello",
  "category": "MARKETING",
  "components": [
    {
      "text": "Hello {{firstname_contact}}",
      "buttons": [
        {
          "text": "Visit us",
          "url": "https://ringover.com",
          "phone_number": "33612345678"
        }
      ],
      "variables": [
        {
          "variable_label": "firstname_contact",
          "example_value": "John"
        }
      ]
    }
  ]
}

Response

Successful operation — returns the UUID of the newly created template.

string required

Example response

"1eb09f33-348e-42e6-bfb3-361df133c82e"

Changes

    • info

      added the non-success response with the status

    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      added the new optional request property

    • info

      added the new optional request property