Create template | Chat Bridge

curl -X POST https://connect.chatbridge.mx/v1/whatsapp/templates \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "confirmacion_registro",
  "category": "UTILITY",
  "parameter_format": "POSITIONAL",
  "language": "es_MX",
  "components": [
    {
      "type": "BODY",
      "text": "¡Hola {{1}}! Tu registro ha sido exitoso. Usuario: {{2}}",
      "example": {
        "body_text": [
          [
            "María",
            "maria@email.com"
          ]
        ]
      }
    }
  ]
}'

{
  "_id": "string",
  "whatsapp_account": "string",
  "name": "string",
  "category": "MARKETING",
  "language": "es_MX",
  "status": "APPROVED",
  "parameter_format": "POSITIONAL",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "string",
      "url": "string",
      "location": {
        "latitude": 1.1,
        "longitude": 1.1,
        "name": "string",
        "address": "string"
      },
      "add_security_recommendation": true,
      "code_expiration_minutes": 1,
      "example": {},
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "string",
          "url": "string",
          "phone_number": "string",
          "otp_type": "COPY_CODE",
          "example": [
            "string"
          ]
        }
      ],
      "cards": [
        {
          "components": [
            null
          ]
        }
      ]
    }
  ]
}

Creates a new template and submits it to Meta for approval. The template is created in PENDING status; Meta reviews it within approximately 1 to 24 hours. The BODY component is required except for carousel-type templates.

Authentication

x-api-keystring

Account authentication key.

AuthorizationBearer

OAuth 2.0 access token issued by POST /api/oauth/token (client-credentials). Takes precedence over x-api-key when both are sent. See the Authentication section.

Request

This endpoint expects an object.

namestringRequired<=512 characters

Unique template name (snake_case, lowercase only).

categoryenumRequired

Allowed values:

parameter_formatenumRequired

Variable format. POSITIONAL uses {{1}}, {{2}}; NAMED uses {{name}}. The two formats cannot be mixed in a single template.

Allowed values:

languagestringRequired

componentslist of objectsRequired

Template components. Must include at least one BODY.

message_send_ttl_secondsintegerOptional1-604800

Message time-to-live, in seconds. Optional.

Response

Template created in PENDING status.

_idstringOptional

whatsapp_accountstringOptional

namestringOptional

categoryenumOptional

Allowed values:

languagestringOptional

statusenumOptional

Allowed values:

parameter_formatenumOptional

Variable format. POSITIONAL uses {{1}}, {{2}}; NAMED uses {{name}}. The two formats cannot be mixed in a single template.

Allowed values:

componentslist of objectsOptional

Errors

400

Bad Request Error

409

Conflict Error