Update a conversation

import requests
url = "https://example.ada.support/api/v2/conversations/conversation_id/"
payload = { "metadata": {
        "pass": "example_string_value",
        "initial_url": "https://example.com",
        "locale": "en-CA",
        "confidence": 0.95
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "id": "5df263b7db5a7e6ea03fae9b",
  "channel_id": "5df263b7db5a7e6ea03fae9b",
  "end_user_id": "5df263b7db5a7e6ea03fae9b",
  "status": "active",
  "created_at": "2020-09-20T00:00:00+00:00",
  "updated_at": "2020-09-20T00:00:00+00:00",
  "metadata": {
    "pass": "example_string_value",
    "initial_url": "https://example.com",
    "locale": "en-CA",
    "confidence": 0.95
  }
}

Update a conversation's metadata by its ID

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

conversation_idstringRequiredformat: "id"

The ID of the conversation to update

Request

This endpoint expects an object.

metadatamap from strings to nullable strings or booleans or integers or doublesRequired

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

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

idstringRead-onlyformat: "id"

The ID of the conversation

channel_idstring

The ID of the channel

end_user_idstringformat: "id"

The ID of the end user participating in the conversation

statusenumRead-only

The status of the conversation

Allowed values:

created_atstringRead-only

The date and time the conversation was created

updated_atstringRead-only

The date and time the conversation was last updated

metadatamap from strings to strings or booleans or integers or doubles

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)

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)

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error