Skip to main content
POST
Bulk add or remove contact tags

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
action
enum<string>
required

Whether to add or remove the given tag(s).

Available options:
add,
remove
contact_ids
string[]

Explicit contact ids to target (max 50,000). Provide this OR filters, not both.

filters
object

Segment filter AST resolving the audience server-side (up to 100,000 contacts). Provide this OR contact_ids.

tag
string

A single tag to apply or remove (legacy form). Provide this OR tags.

Maximum string length: 50
tags
string[]

Up to 25 tags to apply or remove atomically. Provide this OR tag.

Maximum string length: 50

Response

Tags applied inline (selection at or below the async threshold).

data
object
meta
object