Skip to main content

WabaTemplateCreate

Payload to register a WABA template. WabaTemplateCreateRaw (used by the auto endpoint) derives name/ext_id automatically from the channel and prepared message; WabaTemplateCreate requires them explicitly.

company_idCompany Idrequired

ID of the owning company (the top-level tenant account).

prepared_msg_idPrepared Msg Idrequired

ID of the prepared message to base the template on.

channel_idChannel Idrequired

ID of the messaging channel this record relates to.

variables object[]

Variables to substitute into the template, each sourced from a lead or contact field.

  • Array [
    • sourceSource

    Whether the value comes from the lead or the contact.

    Possible values: [lead, contact]

    Default value: lead
    keyKeyrequired

    The field key to read the value from.

  • ]
    • statusStatus

    Possible values: [pending, approved, rejected, failed, paused]

    Default value: pending
    categoryCategory

    WABA template category — marketing, utility, or authentication.

    Possible values: [marketing, utility, authentication]

    Default value: marketing
    typeType

    Template media type — text, video, image, or document.

    Possible values: [text, video, image, document]

    Default value: text
    example object

    Example rendering of the template body.

    anyOf
    string
    vertical object
    anyOf
    string
    langLang

    Template language (ru or en_US).

    Possible values: [ru, en_US]

    Default value: ru
    header object

    Optional template header text.

    anyOf
    string
    example_header object
    anyOf
    string
    footer object

    Optional template footer text.

    anyOf
    string
    buttonsundefined[]
    ext_idExt Idrequired
    nameNamerequired
    WabaTemplateCreate
    {
      "company_id": 0,
      "prepared_msg_id": 0,
      "channel_id": 0,
      "variables": [
        {
          "source": "lead",
          "key": "string"
        }
      ],
      "status": "pending",
      "category": "marketing",
      "type": "text",
      "example": "string",
      "vertical": "string",
      "lang": "ru",
      "header": "string",
      "example_header": "string",
      "footer": "string",
      "buttons": [
        null
      ],
      "ext_id": "string",
      "name": "string"
    }