Sign in

v3

latestOpenAPI 3.1.02026-08-087684214.2 KB
conversations

Update Conversation

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.

patch/v1/conversations/{conversation_id}

Path parameters

conversation_idstring required

Request body

metadataobject nullable
group_namestring nullable

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

Example request

{
  "group_name": "Weekend Trip"
}

Response

Successful Response

idstring required
agentIdstring nullable
phoneNumberIdstring required
phoneNumberstring required
participantstring required
isGroupboolean
groupIdstring nullable
groupNamestring nullable
groupIconUrlstring nullable
lastMessageAtstring date-time required
messageCountinteger required
metadataobject nullable
createdAtstring date-time required