Skip to main content
POST
Revoke group

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string<uuid>
required

Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.

Path Parameters

groupId
string<uuid>
required

The token group group_id

Body

application/json
reason
string

Free-text reason, recorded on the history event of each token the action changes

Maximum string length: 500
Example:

"Card reported lost"

Response

The operation was accepted

operation_id
string<uuid>
required

Identifies this background operation

group_id
string<uuid>
required
action
enum<string>
required
Available options:
ACTIVATE,
SUSPEND,
REACTIVATE,
REVOKE
status
enum<string>
required

Progress of the operation

Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
FAILED
total
integer
required

Member tokens when the action was requested

Required range: x >= 0
eligible
integer
required

Members whose status the action applies to

Required range: x >= 0
succeeded
integer
required

Eligible members the action has been applied to

Required range: x >= 0
failed
integer
required

Eligible members the action failed on

Required range: x >= 0
skipped
integer
required

Members whose status the action does not apply to; total minus eligible

Required range: x >= 0
created_at
string<date-time>
required
failures
object[]

The members the action failed on. Absent until the operation has processed tokens

completed_at
string<date-time> | null

When the operation reached COMPLETED or FAILED; null until then