Skip to main content
POST
Add and remove field tags on a component.

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

UUID of the component whose fields are being tagged.

Body

application/json

Tag mutations for fields of one component. Items apply independently and report their own outcome; nothing is atomic across items. Two items sharing a tag_id and address are rejected with 400 rather than resolved last wins.

assignments
object[]
required

More than 500 is rejected with 400 rather than partly applied.

Required array length: 1 - 500 elements
version_id
string

The component version addresses resolve against, and whose commit resolves the appended events' EffectiveSince* fields. Defaults to the newest version.

Response

Per item outcomes, in request order. Item level refusals are reported here rather than as an error status, so a partly applied batch stays legible per address. A batch is not a transaction: one bad address must not reject the other 499.

Per item outcomes for a bulk tag mutation. The status is 200 whenever the body itself was valid, because each item carries its own outcome.

results
object[]
required

One entry per requested mutation, in request order.