Update conversation metadata

Update metadata for a specific conversation.

PUT /ai/conversations/{conversation_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const conversation = await client.ai.conversations.update('conversation_id');

console.log(conversation.data);

200

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2025-04-15T13:07:28.764Z",
    "metadata": {
      "telnyx_conversation_channel": "sms",
      "telnyx_agent_target": "[phone]",
      "telnyx_end_user_target": "[phone]",
      "assistant_id": "assistant-123"
    },
    "last_message_at": "2025-04-15T13:07:28.764Z",
    "name": ""
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

conversation_id · string · required

The ID of the conversation to update

Body

application/json

metadata · object

Metadata associated with the conversation. Set ai_disabled to true to stop AI from responding to messages (e.g., when a human agent takes over). Set to false to re-enable AI responses.

Show child attributes

Response

200

application/json

Successful Update

data · object

Show child attributes