WhatsApp Templates

WhatsApp Templates

Get all WhatsApp message templates

get

Retrieve all message templates owned by a WhatsApp Business Account with optional filters.

Authorizations

apiAuth

Path parameters

whatsappBusinessAccountstringRequired

ID of the WhatsApp Business Account

Query parameters

limitintegerOptional

The maximum number of templates to return

Example: 10

statusstringOptional

Filter templates by status

Example: APPROVED

categorystringOptional

Filter templates by category

Example: MARKETING

languagestringOptional

Filter templates by language code

Example: en

Responses

200

Templates retrieved successfully

application/json

idstringOptionalExample: 1615318605691911

namestringOptionalExample: dreams

languagestringOptionalExample: en

categorystringOptionalExample: MARKETING

statusstringOptionalExample: APPROVED

401

Failed to get a valid access token

application/json

500

Unable to fetch templates

application/json

get

/api/whatsapp/{whatsappBusinessAccount}/message-templates

HTTPcURLJavaScriptPython

GET /api/whatsapp/{whatsappBusinessAccount}/message-templates HTTP/1.1
Accept: */*

[
  {
    "id": "1615318605691911",
    "name": "dreams",
    "language": "en",
    "category": "MARKETING",
    "status": "APPROVED"
  }
]

Get a specific WhatsApp message template by ID

get

Path parameters

idstringRequired

Responses

200

Template Information retrieved successfully

application/json

objectOptional

404

No template found with this ID

get

/api/whatsapp/message-templates/{id}

HTTPcURLJavaScriptPython

GET /api/whatsapp/message-templates/{id} HTTP/1.1
Accept: */*

{}

Create a new template

post

Body

application/json

namestring · max: 512RequiredExample: seasonal_promotion

languagestringRequiredExample: en_US

categorystringRequiredExample: MARKETING

Responses

200

Template created successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Template created successfully

400

Validation Error(s) or Facebook API Error

application/json

post

/api/{whatsappBusinessAccount}/message-templates

HTTPcURLJavaScriptPython

POST /api/{whatsappBusinessAccount}/message-templates HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "name": "seasonal_promotion",
  "language": "en_US",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "text": "Our {{1}} is on!",
      "example": {
        "header_text": [
          [
            "the end of August"
          ]
        ]
      }
    }
  ]
}

{
  "success": true,
  "message": "Template created successfully"
}

Update a WhatsApp message template

post

Edit a WhatsApp message template by changing its category or components. Only templates with an APPROVED, REJECTED, or PAUSED status can be edited.

Path parameters

whatsappBusinessAccountstringRequired

WhatsApp Business Account ID

templateIdstringRequired

Template ID

Body

application/json

categorystringOptional

New category for the template.

Example: MARKETING

Responses

200

Template updated successfully

application/json

successbooleanOptionalExample: true

400

Validation error

application/json

post

/api/{whatsappBusinessAccount}/message-templates/{templateId}

HTTPcURLJavaScriptPython

POST /api/{whatsappBusinessAccount}/message-templates/{templateId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "Shop now and use code {{1}}.",
      "example": {
        "body_text": [
          "25OFF"
        ]
      },
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Unsubscribe"
        }
      ]
    }
  ]
}

{
  "success": true
}

Delete a WhatsApp message template

delete

Delete a WhatsApp message template by specifying its ID.

Path parameters

whatsappBusinessAccountstringRequired

WhatsApp Business Account ID

templatestringRequired

Template ID to be deleted

Query parameters

namestringRequired

Template name to be deleted

Responses

200

Template deleted successfully

application/json

successbooleanOptionalExample: true

400

Validation error

application/json

401

Unauthorized

application/json

500

Server error

application/json

delete

/api/whatsapp/{whatsappBusinessAccount}/message-templates/{templateID}

HTTPcURLJavaScriptPython

DELETE /api/whatsapp/{whatsappBusinessAccount}/message-templates/{templateID}?name=text HTTP/1.1
Accept: */*

{
  "success": true
}