Update participant status
Update a participant’s lifecycle state.
ACTIVE: the participant can earn and spend normallySUSPENDED: temporarily frozen. Financial actions (CREDIT,DEBIT,HOLD,RELEASE,FORFEIT,COUNTER) are blocked. Metadata actions (TAG,SET_ATTRIBUTE,SET_TIER) are still allowed. Reversible by setting status back toACTIVECLOSED: deactivated. Same restrictions asSUSPENDED. Can be transitioned back toACTIVEorSUSPENDED
FAILED. Events where only allowed actions match will still complete successfully.
Authorizations
API key passed in the X-API-Key header.
Path Parameters
Participant ID
Body
State update
Lifecycle state
ACTIVE, SUSPENDED, CLOSED "SUSPENDED"
Force bypasses the group last-admin guard for incident response. When true, suspending/closing a participant who is the sole active ADMIN of a group proceeds and detaches the participant's ADMIN membership from each such group instead of returning 409 last_admin_status_change_forbidden.
false
Response
Participant updated
Key-value metadata. Each key is accessible in rules via the participant.attribute. shorthand (null if unset) or get(participant.attributes, "key", "")
Current balances per asset, split by bucket
Numeric accumulators, returned as strings for precision
When the participant was created
"2024-01-15T10:30:00Z"
Display name
"Jane Doe"
Contact email
"jane@example.com"
Your application's identifier for this user
"user_123"
First name
"Jane"
Participant ID
"550e8400-e29b-41d4-a716-446655440000"
Last name
"Doe"
Contact phone
"+15551234567"
Programs this participant is enrolled in
Lifecycle state
"ACTIVE"
Labels for segmentation, accessible in rules via participant.tag. (true/false) or 'name' in participant.tags
Current tier level per tier type
When the participant was last modified
"2024-01-15T10:30:00Z"