Skip to main content
PUT
One call for a selection, whatever the table: accounts, people or opportunities. Every subject in one request must be the same subject_type, and the tags must come from the field for that subject. The response reports how many records were written.
Prefer add over replace across a mixed selection. A bulk replace discards whatever each record already carried, and those records rarely carried the same thing. The app’s bulk action sends add for exactly this reason.
A request with more than 100 records is an error, and the whole request is rejected. Split the selection and send several calls of up to 100 records.

Authorizations

Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Body

application/json

Send exactly one of subjects and filters.

subjects
object[]

The records to tag, all of one subject type.

filters
object

In place of subjects, every record the table's list matches, sent as that list's own body. Needs subject_type.

subject_type
enum<string>

The record type filters lists.

Available options:
account,
person,
path
tag_ids
string[]

The tags to add, remove or set, by id (the tag's Clustr id or its id).

mode
enum<string>

replace makes tag_ids each record's tags, add adds them, remove takes them off.

Available options:
replace,
add,
remove

Response

Typed result envelope.

success
boolean
required
data
object
required