Retrieve a tag
/tags/{tag_id}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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
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.
length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/tags/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 }}Create a tag POST
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.
Update a tag PATCH
Renames a tag. The new name must be unique within the account. To avoid overwriting a newer version, send the `ETag` returned by the retrieve operation in the `If-Match` header. If the header is omitted, the update is applied to the current revision. Replicated tags are read-only. Attempts to update them return `403 Forbidden` with the `replica_readonly` error code.