Get Templates

List WhatsApp message templates for a specific sender

GET /user/whatsapp/senders/{senderId}/templates

cURL

curl -X GET "https://app.cloudone-ai.com/api/user/whatsapp/senders/12/templates" \
  -H "Authorization: Bearer YOUR_API_KEY"

200 Response

{
  "data": [
    {
      "id": 45,
      "name": "appointment_reminder",
      "language": "en",
      "category": "utility",
      "status": "approved",
      "body_text": "Hi {{1}}, this is a reminder for your appointment on {{2}} at {{3}}. Reply YES to confirm or NO to reschedule.",
      "variables": ["customer_name", "date", "time"],
      "has_variables": true
    },
    {
      "id": 46,
      "name": "welcome_message",
      "language": "en",
      "category": "marketing",
      "status": "approved",
      "body_text": "Welcome to Acme Corp! We're excited to have you. How can we help you today?",
      "variables": [],
      "has_variables": false
    }
  ]
}

This endpoint returns all message templates associated with a specific WhatsApp sender. Templates are required for initiating conversations or messaging users outside the 24-hour messaging window.

Path Parameters

senderId · integer · required

The ID of the WhatsApp sender (obtained from the Get Senders endpoint)

Query Parameters

status · string

Filter templates by approval status. Default: approved. Use all to return all templates regardless of status.

Response Fields

data · array

Show Template object properties

id · integer

The unique identifier of the template. Use this when sending template messages.

name · string

The template name as registered with Meta (e.g., order_confirmation, appointment_reminder)

language · string

The template language code (e.g., en, es, pt_BR)

category · string

The template category: marketing, utility, or authentication

status · string

The approval status: approved, pending, or rejected

body_text · string

The template body text, with variable placeholders shown as {{1}}, {{2}}, etc.

variables · array

List of variable names defined for the template. Empty array if the template has no variables.

has_variables · boolean

Whether this template requires variables to be provided when sending

Error Responses

404 Not Found

Show Error Response

success · boolean

false

error · string

Sender not found

error_code · string

SENDER_NOT_FOUND

cURL

curl -X GET "https://app.cloudone-ai.com/api/user/whatsapp/senders/12/templates" \
  -H "Authorization: Bearer YOUR_API_KEY"

200 Response

{
  "data": [
    {
      "id": 45,
      "name": "appointment_reminder",
      "language": "en",
      "category": "utility",
      "status": "approved",
      "body_text": "Hi {{1}}, this is a reminder for your appointment on {{2}} at {{3}}. Reply YES to confirm or NO to reschedule.",
      "variables": ["customer_name", "date", "time"],
      "has_variables": true
    },
    {
      "id": 46,
      "name": "welcome_message",
      "language": "en",
      "category": "marketing",
      "status": "approved",
      "body_text": "Welcome to Acme Corp! We're excited to have you. How can we help you today?",
      "variables": [],
      "has_variables": false
    }
  ]
}

Notes

• Only approved templates are returned by default. Templates with pending or rejected status cannot be used to send messages.
• Template approval status is synced with Meta every 4 hours automatically.
• Variables in body_text are shown as {{1}}, {{2}}, etc. The variables array provides human-readable names for each placeholder.
• Templates are required when messaging a user for the first time or outside the 24-hour messaging window.