Sign in

v50

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-06-1841147599.2 KB
Templates

Create a new template

Creates a new message template with header, body, footer, and buttons. The template can be submitted for review immediately or saved as draft for later submission.

post/v3/templates

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

categorystring nullable

Template category: MARKETING, UTILITY, AUTHENTICATION (optional, auto-detected if not provided)

languagestring nullable

Template language code (e.g., en_US) (optional, auto-detected if not provided)

creation_sourcestring nullable

Source of template creation (default: from-api)

submit_for_reviewboolean

Whether to submit the template for review after creation (default: false)

Example request

{
  "category": "MARKETING",
  "language": "en_US",
  "definition": {
    "header": null,
    "body": {
      "multiChannel": {
        "type": null,
        "template": "Hello {{0:variable}}! Welcome to {{1:variable}}.",
        "variables": [
          {
            "id": 0,
            "name": "name",
            "type": "variable",
            "props": {
              "variableType": "text",
              "sample": "John",
              "regex": null,
              "url": null,
              "shortUrl": null,
              "alt": null,
              "mediaType": null
            }
          },
          {
            "id": 1,
            "name": "company",
            "type": "variable",
            "props": {
              "variableType": "text",
              "sample": "SentDM",
              "regex": null,
              "url": null,
              "shortUrl": null,
              "alt": null,
              "mediaType": null
            }
          }
        ]
      },
      "sms": null,
      "whatsapp": null,
      "rcs": null
    },
    "footer": null,
    "buttons": null,
    "definitionVersion": "1.0",
    "authenticationConfig": null
  },
  "creation_source": null,
  "submit_for_review": false,
  "sandbox": false
}

Response

Template created successfully

successboolean

Indicates whether the request was successful