Renames or recolours a tag; every record carrying it follows.
const url = 'https://example.com/api/v1/provision/admin/tags/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"name":"example","color":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/api/v1/provision/admin/tags/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "color": "example" }'Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Identifier of the tag.
Request Bodyrequired
Section titled “Request Bodyrequired”Cancels the request.
Admin update for a registry entry. Null leaves a field unchanged. A tag’s scope is fixed at creation: moving a tag between vocabularies would silently retag records in a scope that never asked for it, so it is not offered.
object
New display name, or null to leave it unchanged. Renaming carries every assignment with it.
New chip colour as a #rrggbb hex triplet, an empty string to clear it, or null to leave it unchanged.
Examplegenerated
{ "name": "example", "color": "example"}Admin update for a registry entry. Null leaves a field unchanged. A tag’s scope is fixed at creation: moving a tag between vocabularies would silently retag records in a scope that never asked for it, so it is not offered.
object
New display name, or null to leave it unchanged. Renaming carries every assignment with it.
New chip colour as a #rrggbb hex triplet, an empty string to clear it, or null to leave it unchanged.
Examplegenerated
{ "name": "example", "color": "example"}Admin update for a registry entry. Null leaves a field unchanged. A tag’s scope is fixed at creation: moving a tag between vocabularies would silently retag records in a scope that never asked for it, so it is not offered.
object
New display name, or null to leave it unchanged. Renaming carries every assignment with it.
New chip colour as a #rrggbb hex triplet, an empty string to clear it, or null to leave it unchanged.
Examplegenerated
{ "name": "example", "color": "example"}Responses
Section titled “Responses”OK
A tag in the tenant’s registry: a free-form organizing label that records in one scope can be filtered by. Tags are vendor-facing catalog organization only — they never reach an entitlement snapshot, a license token, an activation decision, or the end-user portal.
object
Registry identifier.
The vocabulary this tag belongs to.
Display name as first written. Uniqueness is case-insensitive within a tenant and scope.
Optional chip colour as a #rrggbb hex triplet; null renders in the default chip colour.
How many records currently carry this tag, across every scope-eligible entity.
Whether the tag has been soft-deleted.
When the tag was first created — by an administrator, or implicitly by being typed on a record.
When the tag was last renamed or recoloured.
Optimistic-concurrency revision.
A tag in the tenant’s registry: a free-form organizing label that records in one scope can be filtered by. Tags are vendor-facing catalog organization only — they never reach an entitlement snapshot, a license token, an activation decision, or the end-user portal.
object
Registry identifier.
The vocabulary this tag belongs to.
Display name as first written. Uniqueness is case-insensitive within a tenant and scope.
Optional chip colour as a #rrggbb hex triplet; null renders in the default chip colour.
How many records currently carry this tag, across every scope-eligible entity.
Whether the tag has been soft-deleted.
When the tag was first created — by an administrator, or implicitly by being typed on a record.
When the tag was last renamed or recoloured.
Optimistic-concurrency revision.
Example
{ "scope": "Product"}A tag in the tenant’s registry: a free-form organizing label that records in one scope can be filtered by. Tags are vendor-facing catalog organization only — they never reach an entitlement snapshot, a license token, an activation decision, or the end-user portal.
object
Registry identifier.
The vocabulary this tag belongs to.
Display name as first written. Uniqueness is case-insensitive within a tenant and scope.
Optional chip colour as a #rrggbb hex triplet; null renders in the default chip colour.
How many records currently carry this tag, across every scope-eligible entity.
Whether the tag has been soft-deleted.
When the tag was first created — by an administrator, or implicitly by being typed on a record.
When the tag was last renamed or recoloured.
Optimistic-concurrency revision.
Example
{ "scope": "Product"}Bad Request
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Unauthorized
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}