Skip to main content
PATCH
/
v1
/
participants
/
{id}
/
state
/
attributes
Update participant attributes
curl --request PATCH \
  --url https://api.scrip.dev/v1/participants/{id}/state/attributes \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "attributes": {
    "plan": "premium",
    "region": "us-east"
  }
}
'
{
  "attributes": {
    "plan": "premium",
    "region": "us-east"
  }
}
Merges the provided attributes into the participant’s existing attributes. Existing keys included in the request are updated to the new value. New keys are added. Keys not included in the request are left unchanged. To remove a key entirely, use the delete attribute endpoint. This merge behavior makes the endpoint safe for partial updates without risk of accidentally clearing unrelated attributes.
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

​
id
string<uuid>
required

Participant ID

Body

application/json

Attributes to merge

​
attributes
object
required

Key-value pairs to merge into existing attributes

Example:
{ "plan": "premium", "region": "us-east" }

Response

Updated attributes

​
attributes
object

Key-value attributes

Example:
{ "plan": "premium", "region": "us-east" }