Skip to content

Folds a tag into another in the same scope and deletes the source.

POST
/api/v1/provision/admin/tags/{tagId}/merge
curl --request POST \
--url https://example.com/api/v1/provision/admin/tags/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/merge \
--header 'Content-Type: application/json' \
--data '{ "intoTagId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
tagId
required
string format: uuid

Identifier of the tag to fold away.

Cancels the request.

Admin request to fold one tag into another within the same scope.

object
intoTagId

The tag to keep. Every record carrying the merged tag gains this one instead, duplicates collapse, and the merged tag is deleted. Both tags must be in the same scope.

string format: uuid
Examplegenerated
{
"intoTagId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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
id

Registry identifier.

string format: uuid
scope

The vocabulary this tag belongs to.

Allowed values: Product FeatureCatalog Entitlement
name

Display name as first written. Uniqueness is case-insensitive within a tenant and scope.

string
color

Optional chip colour as a #rrggbb hex triplet; null renders in the default chip colour.

null | string
usageCount

How many records currently carry this tag, across every scope-eligible entity.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isDeleted

Whether the tag has been soft-deleted.

boolean
creationTimeStamp

When the tag was first created — by an administrator, or implicitly by being typed on a record.

string format: date-time
lastUpdateTimeStamp

When the tag was last renamed or recoloured.

null | string format: date-time
revisionNumber

Optimistic-concurrency revision.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

Bad Request

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Unauthorized

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string