PATCH

Update Conversation


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a conversation.

Each time the conversation is updated, revision increments by 1. The current revision must be passed when updating the conversation. This ensures you're working with the latest conversation and prevents unintended overwrites.

A field mask is required. Only fields included in the mask are updated.

Use this method to:

  • Rename a conversation: set title. The title is trimmed, must have 1 to 200 characters, and can't be new chat.
  • Delete a conversation: set status to ARCHIVED. ARCHIVED is the only status you can set, and only on an ACTIVE conversation.

An archived conversation can't be updated. The call fails with CONVERSATION_ARCHIVED.

The other fields a conversation holds are set automatically as the coding agent works.

Endpoint
PATCH
https://www.wixapis.com/containers/chat/v1/conversations/{conversation.id}

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?