Skip to navigation
API ReferenceConversations

Set conversation custom attributes

The object that you send replaces all the custom attributes of the conversation.

Authentication

api_access_tokenstring

An API key that an administrator creates in Settings > Developer. The personal access token of a user does not work. A key reaches every inbox, conversation, and contact in the account that created it, and nothing in other accounts.

Path parameters

account_idintegerRequired

The id of your account. It is the number after /accounts/ in the dashboard URL.

conversation_idintegerRequired

The conversation number in the dashboard URL (display_id). It is not the internal id of the conversation.

Request

This endpoint expects an object.
custom_attributesmap from strings to anyRequired

Response

The custom attributes of the conversation.
custom_attributesmap from strings to anyOptional

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error