Update Conversation | AgentPhone

import { AgentPhoneClient } from "agentphone";
async function main() {
    const client = new AgentPhoneClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.conversations.updateConversation("conversation_id", {});
}
main();

{
  "id": "string",
  "phoneNumberId": "string",
  "phoneNumber": "string",
  "participant": "string",
  "lastMessageAt": "2024-01-15T09:30:00Z",
  "messageCount": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "messages": [
    {
      "id": "string",
      "body": "string",
      "fromNumber": "string",
      "toNumber": "string",
      "direction": "string",
      "receivedAt": "2024-01-15T09:30:00Z",
      "senderIdentifier": "string",
      "channel": "string",
      "mediaUrl": "string",
      "mediaUrls": [
        "string"
      ],
      "reactions": [
        {
          "id": "string",
          "reactionType": "string",
          "fromNumber": "string",
          "direction": "string",
          "createdAt": "2024-01-15T09:30:00Z"
        }
      ],
      "replyTo": {
        "messageId": "string",
        "message": "string",
        "mediaUrls": [
          "string"
        ]
      }
    }
  ],
  "agentId": "string",
  "isGroup": false,
  "groupId": "string",
  "groupName": "string",
  "groupIconUrl": "string",
  "participants": [
    {
      "identifier": "string",
      "name": "string"
    }
  ],
  "metadata": {}
}

Update a conversation.

metadata: store custom context for AI agents (customer info, order/ticket ids, session state). Replaces the stored object; surfaced in webhook payloads as conversationState.
group_name: rename a group conversation (iMessage groups only). Also renames the underlying iMessage thread.

Only the fields you include are changed: a rename-only PATCH leaves metadata untouched, and vice versa.

Update a conversation. - `metadata`: store custom context for AI agents (customer info, order/ticket ids, session state). Replaces the stored object; surfaced in webhook payloads as `conversationState`. - `group_name`: rename a group conversation (iMessage groups only). Also renames the underlying iMessage thread. Only the fields you include are changed: a rename-only PATCH leaves metadata untouched, and vice versa.

Authentication

AuthorizationBearer

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

Path parameters

conversation_idstringRequired

Request

This endpoint expects an object.

metadataobject or nullOptional

group_namestring or nullOptional

New display name for a group conversation. iMessage groups only; also renames the underlying iMessage thread. Ignored (omit) for 1:1 chats.

Response

Successful Response

idstring

phoneNumberIdstring

phoneNumberstring

participantstring

lastMessageAtdatetime

messageCountinteger

createdAtdatetime

messageslist of objects

agentIdstring or null

isGroupbooleanDefaults to false

groupIdstring or null

groupNamestring or null

groupIconUrlstring or null

participantslist of objects or null

metadataobject or null

Errors

422

Unprocessable Entity Error