API Referenceconversations

Update Conversation

Updates the requested conversation.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
idstringRequiredformat: "id"
The ID of the conversation to update.
applies_to_partsobjectOptional
brandstringOptionalformat: "id"
The brand associated with the conversation.
channelsobjectOptional
custom_fieldsobjectOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

descriptionstringOptionalformat: "text"
The updated description for the conversation.
groupstringOptionalformat: "id"
The group that the conversation is associated with.
is_frozenbooleanOptional
Whether the conversation is frozen.
is_spambooleanOptional
Whether the conversation is spam.
membersobjectOptional
metadataobjectOptional
owned_byobjectOptional
source_channel_v2stringOptionalformat: "id"
Source channel ID of the conversation.
stageobjectOptional
Updates an object's stage.
statusstringOptionalformat: "text"
The updated status of the conversation.
tagsobjectOptional
titlestringOptionalformat: "text"
The updated title of the conversation.

Response

The response for updating a conversation.
conversationobject

Errors