Skip to main content
DELETE
/
v1
/
participants
/
{id}
/
state
/
counters
/
{key}
Delete participant counter
curl --request DELETE \
  --url https://api.scrip.dev/v1/participants/{id}/state/counters/{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 counter from a participant entirely. The key is passed as a path parameter. Once deleted, the counter no longer appears in the counters list and any rule conditions referencing it will evaluate as if it does not exist. This is a permanent deletion, not a reset. To set a counter back to zero while keeping it defined, use the set counter endpoint with a value of 0 instead. 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

Counter key

Response

Counter removed