Skip to main content

contact

payload object[]
  • Array [
  • additional_attributesobject

    The object containing additional attributes related to the contact

    availability_statusstring

    The availability status of the contact

    emailstring

    The email address of the contact

    idinteger

    The ID of the contact

    namestring

    The name of the contact

    phone_numberstring

    The phone number of the contact

    blockedboolean

    Whether the contact is blocked

    identifierstring

    The identifier of the contact

    thumbnailstring

    The thumbnail of the contact

    custom_attributesobject

    The custom attributes of the contact

    Example: {"attribute_key":"attribute_value","signed_up_at":"dd/mm/yyyy"}
    last_activity_atinteger

    The last activity at of the contact

    created_atinteger

    The created at of the contact

    contact_inboxes object[]
  • Array [
  • source_idstring

    Contact Inbox Source Id

    inbox object
    idnumber

    ID of the inbox

    avatar_urlstring

    The avatar image of the inbox

    channel_idnumber

    The ID of the channel

    namestring

    The name of the inbox

    channel_typestring

    The type of the inbox

    providerstring

    The provider of the inbox

  • ]
  • ]
  • contact
    {
    "payload": [
    {
    "additional_attributes": {},
    "availability_status": "string",
    "email": "string",
    "id": 0,
    "name": "string",
    "phone_number": "string",
    "blocked": true,
    "identifier": "string",
    "thumbnail": "string",
    "custom_attributes": {
    "attribute_key": "attribute_value",
    "signed_up_at": "dd/mm/yyyy"
    },
    "last_activity_at": 0,
    "created_at": 0,
    "contact_inboxes": [
    {
    "source_id": "string",
    "inbox": {
    "id": 0,
    "avatar_url": "string",
    "channel_id": 0,
    "name": "string",
    "channel_type": "string",
    "provider": "string"
    }
    }
    ]
    }
    ]
    }