Skip to main content

Conversation

idstringrequired
Example: conv_xyz123
contact_idstringrequired
Example: cnt_1a2b3c4d5e6f
contact object
idstringrequired

Unique contact identifier

Example: cnt_1a2b3c4d5e6f
phonestring

Phone number in E.164 format

Example: +1234567890
emailstring<email>
Example: john@example.com
first_namestringrequired
Example: John
last_namestring
Example: Doe
full_namestring
Example: John Doe
preferred_channelstring

Possible values: [whatsapp, instagram, sms, email]

Example: whatsapp
metadata object
property name*any
Example: {"customer_id":"cust_123","tier":"premium"}
statusstring

Possible values: [active, inactive, deleted]

Example: active
created_atstring<date-time>
updated_atstring<date-time>
last_contactedstring<date-time>nullable
channelstringrequired

Possible values: [whatsapp, instagram, sms, email]

subjectstring
Example: Order status inquiry
statusstring

Possible values: [open, closed, archived]

prioritystring

Possible values: [low, medium, high]

Example: high
assigned_to object
idstring
namestring
emailstring
labelsstring[]
Example: ["billing","urgent"]
tagsstring[]
message_countinteger
unread_countinteger
created_atstring<date-time>
updated_atstring<date-time>
last_message_atstring<date-time>nullable
last_message_previewstringnullable
Conversation
{
  "id": "conv_xyz123",
  "contact_id": "cnt_1a2b3c4d5e6f",
  "contact": {
    "id": "cnt_1a2b3c4d5e6f",
    "phone": "+1234567890",
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "preferred_channel": "whatsapp",
    "metadata": {
      "customer_id": "cust_123",
      "tier": "premium"
    },
    "status": "active",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "last_contacted": "2024-07-29T15:51:28.071Z"
  },
  "channel": "whatsapp",
  "subject": "Order status inquiry",
  "status": "open",
  "priority": "high",
  "assigned_to": {
    "id": "string",
    "name": "string",
    "email": "string"
  },
  "labels": [
    "billing",
    "urgent"
  ],
  "tags": [
    "string"
  ],
  "message_count": 0,
  "unread_count": 0,
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "last_message_at": "2024-07-29T15:51:28.071Z",
  "last_message_preview": "string"
}