Chat icon

Chat

Interact with the Chat API

Actions253

Conversation → Add Custom Attributes

AI-generated

Summary

Adds or updates custom attribute key-value pairs on a specified conversation.

Inputs

  • accountId (required) — Select the account associated with the conversation.
  • inboxId (required) — Select the inbox containing the target conversation.
  • conversationId (required) — Select or enter the ID of the conversation to update.
  • specifyCustomAttributes — Choose how custom attributes are defined: 'definition' (predefined list), 'keypair' (manual name/value fields), or 'json'.
  • customAttributesDefinition — Predefined conversation attributes selected from a list along with their values.
  • customAttributesKeypair — Custom attribute key-value pairs configured manually.
  • customAttributesJson — JSON object representing the custom attribute key-value pairs to append.

Output shape

a single record

Returns the updated conversation object containing the updated custom attributes payload.

Examples

Example 1: Add custom attributes using predefined definitions

Set Account, Inbox, and Conversation IDs, keep Specify Custom Attributes as 'From Definitions', and add attribute keys and values under Custom Attributes.

Example 2: Add custom attributes via raw JSON object

Set Account, Inbox, and Conversation IDs, set Specify Custom Attributes to 'JSON', and enter a JSON object like {"priority_code": "VIP", "lead_score": "85"}.

Links

Discussion