Set participant tags

curl --request PUT \
  --url https://api.scrip.dev/v1/participants/{id}/state/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "tags": [
    "vip"
  ]
}
'

{
  "tags": [
    "vip"
  ]
}

PUT

participants

{id}

state

tags

Set participant tags

curl --request PUT \
  --url https://api.scrip.dev/v1/participants/{id}/state/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "tags": [
    "vip"
  ]
}
'

{
  "tags": [
    "vip"
  ]
}

Replaces all tags on a participant with the provided set. This is a full replacement, not a merge. Any tags not included in the request body are removed. If you need to add or remove a single tag without affecting the others, use the individual add or remove tag endpoints instead. This endpoint is best suited for bulk tag synchronization from an external system.

For usage patterns and examples, see the State Management guide.

Authorizations

X-API-Key

string

header

required

API key passed in the X-API-Key header.

Path Parameters

string<uuid>

required

Participant ID

Body

application/json

Tags to set

Response

Tags set

Documentation Index

Authorizations

Path Parameters

Body

Response