Update Conversation | AgentPhone

import { AgentPhoneClient } from "agentphone";
async function main() {
    const client = new AgentPhoneClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.conversations.updateConversation({
        conversationId: "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",
      "status": "string",
      "failureReason": "string",
      "errorCode": "string",
      "deliveredAt": "2024-01-15T09:30:00Z",
      "readAt": "2024-01-15T09:30:00Z",
      "mediaUrl": "string",
      "mediaUrls": [
        "string"
      ],
      "content": {},
      "reactions": [
        {
          "id": "string",
          "reactionType": "string",
          "fromNumber": "string",
          "direction": "string",
          "createdAt": "2024-01-15T09:30:00Z"
        }
      ],
      "replyTo": {
        "messageId": "string",
        "message": "string",
        "mediaUrls": [
          "string"
        ]
      }
    }
  ],
  "agentId": "string",
  "channel": "native",
  "isGroup": false,
  "groupId": "string",
  "groupName": "string",
  "groupIconUrl": "string",
  "participants": [
    {
      "identifier": "string",
      "name": "string"
    }
  ],
  "metadata": {},
  "capabilities": {
    "canSendMessages": true,
    "media": true,
    "reactions": true,
    "emojiReactions": true,
    "sendDisabledReason": "string",
    "sendChannel": "string",
    "availableChannels": [
      "string"
    ],
    "mediaChannels": [
      "string"
    ],
    "whatsappWindowExpiresAt": "2024-01-15T09:30:00Z"
  }
}

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 nullOptional

channelstringOptionalDefaults to native

isGroupbooleanOptionalDefaults to false

groupIdstring or nullOptional

groupNamestring or nullOptional

groupIconUrlstring or nullOptional

participantslist of objects or nullOptional

metadataobject or nullOptional

capabilitiesobject or nullOptional

What the caller can do in this conversation, derived from its number's provider and compliance state. Drives the dashboard composer/reaction UI.

Errors

422

Unprocessable Entity Error