Skip to main content
POST
Bulk Update Status

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Bulk status update (used for deactivate / reactivate).

memberIds
string[]
required

IDs of members to update

Minimum array length: 1
status
enum<string>
required

New status for the selected members

Available options:
ACTIVE,
EXPIRED,
CANCELLED,
DELINQUENT,
FROZEN,
INACTIVE,
PENDING,
AWAITING_FORM
comment
string | null

Comment explaining the status change

Response

Successful Response

Aggregate result for a bulk action that fans out per-member.

succeeded
integer
default:0

Number of members the action succeeded for

skipped
integer
default:0

Number of members that were skipped (no-op, e.g. not delinquent)

failed
BulkActionFailure · object[]

Per-member failures with reasons