Skip to main content
POST
Apply an action to many records

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Body

application/json
type
enum<string>
required

What the ids refer to. Anything else returns a 422 with {"success": false}.

Available options:
Conversation,
Contact
ids
integer[]
required

The records to act on. Conversations are named by display_id.

fields
object

Attributes to set — status, assignee_id, team_id, priority, snoozed_until.

labels
object

Labels to add or remove, as {"add": [...], "remove": [...]}.

Response

Accepted