Rename a conversation
Changes the title of one of the caller's conversations (a person's chat, or a conversation of the API key). The new title shows in the workspace's logs too.
PATCH/v1/conversations/{conversation_id}
Requires query.
Send the new title, 1 to 100 characters. Renaming is free. It is gated by the query scope, the same one that lets a connection start conversations, so a connection that can ask can also tidy up its own history.
A person renames their own chats. An API key renames the conversations it started, and can send end_user to be sure it is that person’s. The workspace’s logs show the new title.
Authorizations
Authorizationbearerin headerrequiredPath parameters
conversation_idstringrequiredpattern: ^cnv_[abcdefghjkmnpqrstuvwxyz23456789]{12}$Body
application/jsonrequiredtitlestringrequiredlength: 1–100 charsThe new title, 1 to 100 characters.
end_userstringpattern: ^[\w.@:+\-]{1,200}$API keys only: the end_user of the conversation. When given, a conversation of another end user answers not found.
Response
Rename a conversation
dataobjectrequiredrequest_idstringrequiredPossible codes: invalid_request, unknown_field, invalid_parameter, invalid_cursor
errorobjectrequiredrequest_idstringrequiredPossible codes: authentication_required, invalid_api_key, api_key_expired, api_key_revoked, invalid_access_key
errorobjectrequiredrequest_idstringrequiredPossible codes: insufficient_scope, feature_not_available, admin_required, permission_denied
errorobjectrequiredrequest_idstringrequiredPossible codes: resource_not_found
errorobjectrequiredrequest_idstringrequiredPossible codes: request_too_large
errorobjectrequiredrequest_idstringrequiredPossible codes: rate_limited
errorobjectrequiredrequest_idstringrequiredPossible codes: internal_error
errorobjectrequiredrequest_idstringrequired