conversations

Update a conversation

Update a conversation's metadata by its ID

patch/v2/conversations/{conversation_id}/

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/conversations/{conversation_id}/
  • Auth: HTTP bearer

Path parameters

conversation_idstring id required

The ID of the conversation to update

Request body

metadataobject required

A dictionary of key, value pairs to add to the conversation metadata additively

  • metadata keys may only be of type: string
  • metadata values may only be one of type: string, boolean, integer, or number (float)
  • metadata keys with a null value will be removed from the conversation metadata

Response

Conversation updated

idstring id

The ID of the conversation

channel_idstring

The ID of the channel

end_user_idstring id

The ID of the end user participating in the conversation

status'active' | 'ended'

The status of the conversation

created_atstring

The date and time the conversation was created

updated_atstring

The date and time the conversation was last updated

metadataobject

A dictionary of key value pairs assigned to the conversation. Note: This metadata does not create or set Ada metavariables. To create or update metavariables, use the End Users API.

  • metadata keys may only be of type: string
  • metadata values may only be one of type: string, boolean, integer, or number (float)

Changes

No recorded changes to this operation across all 1 revision of this API.