Creates a tag explicitly. A name already used in the same scope is refused.
const url = 'https://example.com/api/v1/provision/admin/tags';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"scope":"Product","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 POST \ --url https://example.com/api/v1/provision/admin/tags \ --header 'Content-Type: application/json' \ --data '{ "scope": "Product", "name": "example", "color": "example" }'Request Bodyrequired
Section titled “Request Bodyrequired”Cancels the request.
Admin request to create a registry entry explicitly. Creating a tag that already exists in the same tenant and scope is a conflict — use the record editors to apply an existing tag, which create-on-use resolves to the entry already there.
object
The vocabulary the new tag belongs to.
Display name. Whitespace is trimmed and collapsed; , and | are rejected.
Optional chip colour as a #rrggbb hex triplet.
Admin request to create a registry entry explicitly. Creating a tag that already exists in the same tenant and scope is a conflict — use the record editors to apply an existing tag, which create-on-use resolves to the entry already there.
object
The vocabulary the new tag belongs to.
Display name. Whitespace is trimmed and collapsed; , and | are rejected.
Optional chip colour as a #rrggbb hex triplet.
Admin request to create a registry entry explicitly. Creating a tag that already exists in the same tenant and scope is a conflict — use the record editors to apply an existing tag, which create-on-use resolves to the entry already there.
object
The vocabulary the new tag belongs to.
Display name. Whitespace is trimmed and collapsed; , and | are rejected.
Optional chip colour as a #rrggbb hex triplet.
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"}