Update Conversation Status

PATCH

///api/v1/crm/conversations/:id/status

PATCH

/api/v1/crm/conversations/:id/status

curl -X PATCH /api/v1/crm/conversations/id/status \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "status": "open"
}'

{
  "id": "string",
  "tenant_id": "string",
  "channel": "whatsapp",
  "status": "open",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "session_window_expires_at": "2024-01-15T09:30:00Z",
  "session_window_open": true,
  "subject": "string",
  "related_to_type": "string",
  "related_to_id": "string",
  "related_to_name": "string",
  "external_thread_id": "string",
  "contact_wa_id": "string",
  "assigned_to": "string",
  "last_message_at": "2024-01-15T09:30:00Z",
  "last_inbound_at": "2024-01-15T09:30:00Z",
  "last_message_preview": "string",
  "unread_count": 0,
  "first_response_due_at": "2024-01-15T09:30:00Z",
  "first_responded_at": "2024-01-15T09:30:00Z",
  "resolved_at": "2024-01-15T09:30:00Z"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

statusenumRequired

Allowed values:

Response

Successful Response

idstringformat: "uuid"

tenant_idstringformat: "uuid"

channelenum

Allowed values:

statusenum

Allowed values:

created_atdatetime

updated_atdatetime

session_window_expires_atdatetime or nullRead-only

session_window_openbooleanRead-only

Non-WhatsApp channels have no such window, so they are always ‘open’ - the composer must not gate an internal note or an email.

subjectstring or nullOptional

related_to_typestring or nullOptional

related_to_idstring or nullOptionalformat: "uuid"

related_to_namestring or nullOptional

external_thread_idstring or nullOptional

contact_wa_idstring or nullOptional

assigned_tostring or nullOptionalformat: "uuid"

last_message_atdatetime or nullOptional

last_inbound_atdatetime or nullOptional

last_message_previewstring or nullOptional

unread_countintegerOptionalDefaults to 0

first_response_due_atdatetime or nullOptional

first_responded_atdatetime or nullOptional

resolved_atdatetime or nullOptional

Errors

422

Unprocessable Entity Error