Chat icon

Chat

Interact with the Chat API

Actions253

Conversation → Set Custom Attributes

AI-generated

Summary

Set custom attributes on a conversation using pre-defined attribute keys, key-value pairs, or a JSON object.

Inputs

  • accountId (required) — The account containing the target conversation.
  • inboxId (required) — The inbox containing the conversation.
  • conversationId (required) — The ID of the conversation to update.
  • specifyCustomAttributes — Method for supplying attributes: 'definition' (pre-defined keys), 'keypair' (manual key-value pairs), or 'json' (raw JSON).
  • customAttributesDefinition — List of key-value pairs selecting from pre-defined attribute keys.
  • customAttributesKeypair — List of manually defined attribute name-value pairs.
  • customAttributesJson — Raw JSON object containing custom attribute key-value pairs.

Output shape

a single record

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

Examples

Example 1: Set pre-defined custom attributes on a conversation

Select Account, Inbox, and Conversation. Set Specify Custom Attributes to 'From Definitions' and select attribute keys with their corresponding string values.

Example 2: Pass custom attributes using a raw JSON payload

Select Account, Inbox, and Conversation. Set Specify Custom Attributes to 'JSON' and provide a JSON object such as {"vip_status": "gold", "ticket_id": "98765"}.

Links

Discussion