Developers
Users38

Assign a tag

POST/users/{user_id}/tags/{tag_id}

Assigns a tag to the user. The operation is idempotent: the response status indicates whether the tag was newly assigned or was already assigned.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

user_id*string

Public ID of the user, prefixed with usr_.

tag_id*string

Public ID of the tag, prefixed with tag_.

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

Response Body

application/json

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/users/string/tags/string" \  -H "Idempotency-Key: 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  }}

Replace user tags PUT

Replaces the user's entire set of tags with the tags supplied in the request. Assigned tags that are not included are removed. If any supplied tag does not exist in the account, the API returns `404 Not Found` and no changes are made.

Remove a tag DELETE

Removes a tag from the user. The operation is idempotent: removing a tag that is not assigned also succeeds.