Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy. A key carries up to three permissions: public:read for GET requests, public:write for POST, PATCH, and PUT requests, and public:delete for DELETE requests. public:delete is only available together with public:write.

Headers

Idempotency-Key
string

Optional idempotency key: a unique string of 16-200 printable ASCII characters (a UUID is recommended). Retrying the write with the same key within 24 hours returns the stored response of the first call with an X-Idempotent-Replayed: true response header instead of executing it again. Reusing a key with a different request body returns 422 (IDEMPOTENCY_MISMATCH); a duplicate sent while the first call is still running returns 409 with a Retry-After header. Keys are scoped per endpoint and organization.

Required string length: 16 - 200

Body

application/json
name
string
required

The tag's name, trimmed.

Required string length: 1 - 64
organization_id
string<uuid>

Optional. The organization to act in: your own unless you name a descendant your key reaches. An organization outside your key's hierarchy returns 403 ORG_ACCESS_DENIED.

Response

The activity tag already existed; it is returned unchanged.

success
boolean
required
data
object
required

A label on contacts (phone numbers and email addresses) inside one organization. A manual tag has members you add and remove. An activity tag has no stored members: it applies by itself to everyone for whom the activity is true when a send is compiled.