Skip to main content
POST
Tag Profiles

Authorizations

X-API-Key
string
header
required

Body

application/json

Request body for backfilling tags onto existing untagged profiles.

tags
ProfileTagEntry · object[]
required

Profile-to-tag assignments to apply. Each profile may appear at most once.

Required array length: 1 - 1000 elements

Response

Successful Response

Per-outcome report for a tag-backfill request.

Every requested profile lands in exactly one bucket, so updated + len(already_tagged) + len(conflicts) + len(not_found) equals the number of submitted entries.

updated
integer
required

Number of profiles whose tag was set by this request.

already_tagged
string[]
required

Profiles that already carried the exact submitted tag (idempotent no-op).

conflicts
TagConflict · object[]
required

Profiles that already carry a different tag; existing tags are never overwritten.

not_found
string[]
required

Profile ids that do not exist, are deleted, or are not owned by you.