Skip to main content
DELETE
/
v1
/
participants
/
{id}
/
state
/
attributes
/
{key}
Remove participant attribute
curl --request DELETE \
  --url https://api.scrip.dev/v1/participants/{id}/state/attributes/{key} \
  --header 'X-API-Key: <api-key>'
{
  "code": "bad_request",
  "details": {
    "expected": "present",
    "field": "amount",
    "message": "This field is required",
    "reason": "required",
    "received": "<string>"
  },
  "message": "Invalid request parameters"
}
Removes a single attribute from a participant by key. The key is passed as a path parameter. This is the only way to delete an attribute entirely. The update attributes endpoint (PATCH) can overwrite values but cannot remove keys. If the key does not exist, the call returns successfully as a no-op. Returns 204 No Content on success.
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

​
key
string
required

Attribute key to remove

Response

Attribute removed