v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444175204.9 KB

Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.

patch/networks/{networkId}/users/toggleSuspend#suspend

Path parameters

networkIdstring required

The ID of the Wickr network where users will be suspended or unsuspended.

Query parameters

suspendboolean required

A boolean value indicating whether to suspend (true) or unsuspend (false) the specified users.

Headers

X-Client-Tokenstring

A unique identifier for this request to ensure idempotency.

Request body

userIdsUserId[] required

A list of user IDs identifying the users whose suspend status will be toggled. Maximum 50 users per batch request.

Response

Success

messagestring

A message indicating the overall result of the batch suspend status toggle operation.