Skip to main content

PaginatedResponse[WabaTemplateRead]

items object[]required
  • Array [
    • idIdrequired

    Unique numeric identifier of the record.

    company_idCompany Idrequired

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

    prepared_msg_idPrepared Msg Idrequired

    ID of the prepared message this template is based on.

    channel_idChannel Idrequired

    ID of the messaging channel this record relates to.

    ext_idExt Idrequired

    The template's id at the WABA provider.

    nameNamerequired

    The template name registered with the provider.

    variables object[]required

    Ordered variables substituted 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.

  • ]
    • statusStatusrequired

    Provider approval status — pending, approved, rejected, failed, or paused.

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

    categoryCategoryrequired

    WABA template category — marketing, utility, or authentication.

    Possible values: [marketing, utility, authentication]

    typeTyperequired

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

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

    example objectrequired

    Example rendering of the template body.

    anyOf
    string
    vertical objectrequired

    Optional business vertical declared for the template.

    anyOf
    string
    langLangrequired

    Template language (ru or en_US).

    Possible values: [ru, en_US]

    header objectrequired

    Optional template header text.

    anyOf
    string
    example_header objectrequired

    Optional example value for the header.

    anyOf
    string
    footer objectrequired

    Optional template footer text.

    anyOf
    string
    buttonsundefined[]required

    Optional template buttons.

    created_atdate-timerequired

    Creation time (UTC, ISO 8601).

  • ]
    • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[WabaTemplateRead]
    {
      "items": [
        {
          "id": 0,
          "company_id": 0,
          "prepared_msg_id": 0,
          "channel_id": 0,
          "ext_id": "string",
          "name": "string",
          "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
          ],
          "created_at": "2024-07-29T15:51:28.071Z"
        }
      ],
      "page": 0,
      "limit": 0,
      "total": 0,
      "pages": 0
    }