Conversations

Update conversation metadata

Shallow-merge key-value pairs into the conversation's metadata object.

Existing keys are preserved unless explicitly overwritten. Useful for tagging conversations with CRM IDs, sync flags, or any custom data.

Example: { "synced_to_crm": true, "crm_id": "HBS-12345" }

patch/api/v1/conversations/{conversationId}/metadata

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/conversations/{conversationId}/metadata
  • Auth: bearerAuth (a scheme the document does not define)

Path parameters

conversationIdstring required

Conversation ID

Request body

metadataobject required

Key-value pairs to merge into the conversation metadata. Existing keys are preserved unless overwritten.

Example request

{
  "metadata": {
    "synced_to_crm": true,
    "crm_id": "HBS-12345"
  }
}

Response

Updated

successtrue required
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.