Skip to main content
POST
Bulk Freeze Members

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 freeze request - applies the same freeze window to each selected member.

memberIds
string[]
required

IDs of members to freeze

Minimum array length: 1
reason
string
required

Reason for freezing the memberships

freezeDate
string<date-time> | null

When to automatically freeze each member (if None, freezes immediately)

unfreezeDate
string<date-time> | null

When to automatically unfreeze each member

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