conversation_meta

labelsstring[]

Labels associated with the conversation

additional_attributes object

Additional attributes of the conversation

browser object

device_namestring

Name of the device

browser_namestring

Name of the browser

platform_namestring

Name of the platform

browser_versionstring

Version of the browser

platform_versionstring

Version of the platform

refererstring

Referrer URL

initiated_at object

timestampstring

Timestamp when the conversation was initiated

browser_languagestring

Browser language setting

conversation_languagestring

Conversation language

contact object

additional_attributes object

The object containing additional attributes related to the contact

citystring

City of the contact

countrystring

Country of the contact

country_codestring | nullnullable

Country code of the contact

created_at_ipstring

IP address when the contact was created

custom_attributesobject

The custom attributes of the contact

emailstring

The email address of the contact

idinteger

The ID of the contact

identifierstring | nullnullable

The identifier of the contact

namestring

The name of the contact

phone_numberstring | nullnullable

The phone number of the contact

thumbnailstring

The thumbnail of the contact

blockedboolean

Whether the contact is blocked

typestring

The type of entity

Possible values: [contact]

assignee objectnullable

The agent assigned to the conversation

idinteger

account_idinteger

availability_statusstring

The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability field in create or update requests.

Possible values: [online, busy, offline]

auto_offlineboolean

Whether the agent is automatically marked offline when they are away.

confirmedboolean

Whether the agent has confirmed their email address.

emailstring

The email of the agent

available_namestring

The available name of the agent

namestring

The name of the agent

rolestring

The role of the agent

Possible values: [agent, administrator]

thumbnailstring

The thumbnail of the agent

custom_role_idinteger | nullnullable

The custom role id of the agent

agent_last_seen_atstring | nullnullable

Timestamp when the agent last saw the conversation

assignee_last_seen_atstring | nullnullable

Timestamp when the assignee last saw the conversation

conversation_meta

{
  "labels": [
    "string"
  ],
  "additional_attributes": {
    "browser": {
      "device_name": "string",
      "browser_name": "string",
      "platform_name": "string",
      "browser_version": "string",
      "platform_version": "string"
    },
    "referer": "string",
    "initiated_at": {
      "timestamp": "string"
    },
    "browser_language": "string",
    "conversation_language": "string"
  },
  "contact": {
    "additional_attributes": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "created_at_ip": "string"
    },
    "custom_attributes": {},
    "email": "string",
    "id": 0,
    "identifier": "string",
    "name": "string",
    "phone_number": "string",
    "thumbnail": "string",
    "blocked": true,
    "type": "contact"
  },
  "assignee": {
    "id": 0,
    "account_id": 0,
    "availability_status": "online",
    "auto_offline": true,
    "confirmed": true,
    "email": "string",
    "available_name": "string",
    "name": "string",
    "role": "agent",
    "thumbnail": "string",
    "custom_role_id": 0
  },
  "agent_last_seen_at": "string",
  "assignee_last_seen_at": "string"
}