Update

POST

Updates the requested conversation.

Request

This endpoint expects an object.
idstringRequired

The ID of the conversation to update.

applies_to_partsobjectOptional
custom_fieldsmap from strings to anyOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

descriptionstringOptional

The updated description for the conversation.

groupstringOptional

The group that the conversation is associated with.

is_spambooleanOptional

Whether the conversation is spam.

metadataobjectOptional
owned_byobjectOptional
stageobjectOptional

Updates an object’s stage.

statusstringOptional

The updated status of the conversation.

tagsobjectOptional
titlestringOptional

The updated title of the conversation.

user_sessionsobjectOptional

Response

This endpoint returns an object.
conversationobject