Update a tag
/tags/{tag_id}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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
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
curl -X PATCH "https://example.com/tags/string" \ -H "Content-Type: application/json" \ -d '{}'{ "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 }}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.
Delete a tag DELETE
Moves the tag to the trash and removes it from every user it is assigned to. A tag used by an access rule cannot be deleted; the API returns `409 Conflict` with the `tag_in_use` error code. Replicated tags are read-only and cannot be deleted. Attempts to delete them return `403 Forbidden` with the `replica_readonly` error code.