Skip to main content

PaginatedResponse[BlacklistedContactRead]

items object[]required
  • Array [
    • idIdrequired

    Unique numeric identifier of the record.

    product_idProduct Idrequired

    ID of the product (workspace) that owns this record. Most endpoints scope access by product.

    contactContactrequired

    The blocked address value.

    contact_typeContactTyperequired

    The kind of address — phone, username, chat_id, or email.

    Possible values: [phone, username, chat_id, email]

    channel_type objectrequired

    Optional messaging platform the block is scoped to.

    anyOf
    string

    Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]

    created_atdate-timerequired

    Creation time (UTC, ISO 8601).

  • ]
    • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[BlacklistedContactRead]
    {
      "items": [
        {
          "id": 0,
          "product_id": 0,
          "contact": "string",
          "contact_type": "phone",
          "channel_type": "telegram",
          "created_at": "2024-07-29T15:51:28.071Z"
        }
      ],
      "page": 0,
      "limit": 0,
      "total": 0,
      "pages": 0
    }