Update Conversation

POST

Updates the requested conversation.

Request

This endpoint expects an object.
applies_to_partsobjectRequired
custom_schema_specobjectRequired

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.

idstringRequiredformat: "id"

The ID of the conversation to update.

membersobjectRequired
metadataobjectRequired
owned_byobjectRequired
stageobjectRequired

Updates an object’s stage.

tagsobjectRequired
user_sessionsobjectRequired
custom_fieldsobjectOptional

Application-defined custom fields.

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.

statusstringOptionalformat: "text"

The updated status of the conversation.

titlestringOptionalformat: "text"

The updated title of the conversation.

Response

The response for updating a conversation.

conversationobject
Built with