Create a new WhatsApp template

Creates a new draft template that can be later submitted to WhatsApp for approval.

When a whatsapp_config_id (or customer_id) is provided, the template is automatically associated with all production configs that share the same WhatsApp Business Account (WABA).

Note: You cannot associate templates with configs from different WABAs. Attempting to do so will return a 422 validation error.

POST /whatsapp_templates

cURL

simple_text_template

curl --request POST \
  --url https://app.kapso.ai/api/v1/whatsapp_templates \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data @- <<EOF
{
  "template": {
    "name": "welcome_message",
    "language_code": "en_US",
    "category": "UTILITY",
    "components": [
      {
        "type": "BODY",
        "text": "Welcome to our service! We're excited to have you on board."
      }
    ]
  }
}
EOF

201

{
  "data": {
    "id": "template-123abc",
    "name": "appointment_reminder",
    "language_code": "en_US",
    "category": "UTILITY",
    "status": "approved",
    "content": "Hello {{1}}, your appointment is confirmed for {{2}}.",
    "parameter_count": 2,
    "business_account_id": "123456789012345",
    "whatsapp_config_ids": [
      "config-123abc",
      "config-456def"
    ],
    "components": [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "<string>",
        "example": {},
        "buttons": [
          {}
        ]
      }
    ],
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Body

application/json

template · object · required

Show child attributes

whatsapp_config_id · string<uuid>

Optional: Specific WhatsApp phone number configuration to associate with template. Templates can be associated with multiple phone numbers (WhatsApp configs). Association options:

• If whatsapp_config_id provided: associates with that specific phone number only
• If customer_id provided: associates with ALL production configs of that customer
• If neither provided: associates with ALL production configs of the project

customer_id · string<uuid>

Optional: Customer whose WhatsApp configs to associate with template. When provided, the template will be associated with ALL production WhatsApp configs (phone numbers) belonging to this customer, making it available for sending from any of them.

Response

201

application/json

Template created successfully

data · object

Show child attributes