v2

latestOpenAPI 3.0.1raw.githubusercontent.com2026-05-072126235.6 KB
ConversationsV2Conversation

Partially Update a Conversation

Partially update the details of an existing Conversation.

patch/v2/Conversations/{Sid}

Request body

namestring

The name of the Conversation.

status'ACTIVE' | 'INACTIVE' | 'CLOSED'

The state of the Conversation.

Example request

{
  "name": "Support Chat"
}

Response

OK

idstring required

Conversation ID.

accountIdstring required

Account ID.

configurationIdstring required

Configuration ID.

status'ACTIVE' | 'INACTIVE' | 'CLOSED'

Conversation status.

namestring nullable

Conversation name.

createdAtstring date-time

Timestamp when this Conversation was created.

updatedAtstring date-time

Timestamp when this Conversation was last updated.

Example response

{
  "id": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
  "accountId": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "configurationId": "conv_configuration_01k1etk2y5f1y9fpe2epfdtvv2",
  "status": "ACTIVE",
  "name": "Customer Support - Multi-channel",
  "createdAt": "2023-07-01T12:00:00Z",
  "updatedAt": "2023-07-01T12:30:00Z"
}