Developers
Tags5

Create a tag

POST/tags

Creates a tag that can be assigned to users.

Leading and trailing whitespace is removed from the name. Tag names must be unique within the account; if the name is already in use, the API returns 409 Conflict with the already_exists error code.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/tags" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "name": "string",    "object": "tag",    "revision": "string",    "updated_at": "2019-08-24T14:15:22Z",    "users_count": 0  }}

List tags GET

Lists the user tags of the account, sorted alphabetically by name by default. Each tag includes `users_count`, the number of users it is assigned to. Results are paginated with `limit` and `cursor`.

Retrieve a tag GET

Retrieves a tag by its public ID, including the number of users it is assigned to. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the tag to avoid overwriting a newer version.