Skip to navigation
API ReferenceConversations

Replace conversation labels

Replaces all the labels. Send every label that the conversation must have.

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.
labelslist of stringsRequired

Response

The labels of the conversation after the change.
payloadlist of stringsOptional

Errors

401
Unauthorized Error
404
Not Found Error