---
title: "PATCH /networks/{networkId}/users/toggleSuspend#suspend"
method: PATCH
path: "/networks/{networkId}/users/toggleSuspend#suspend"
---

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

`PATCH /networks/{networkId}/users/toggleSuspend#suspend`

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.

## Path parameters

- `networkId` string, required

## Query parameters

- `suspend` boolean, required

## Headers

- `X-Client-Token` string

## Request body

- object
  - `userIds` UserId[], required — A list of user IDs identifying the users whose suspend status will be toggled. Maximum 50 users per batch request.

## Response `200`

Success

- BatchToggleUserSuspendStatusResponse
  - `message` string — A message indicating the overall result of the batch suspend status toggle operation.
  - `successful` BatchUserSuccessResponseItem[] — A list of user IDs whose suspend status was successfully toggled.
    - `userId` string, required — The user ID that was successfully processed.
  - `failed` BatchUserErrorResponseItem[] — A list of suspend status toggle attempts that failed, including error details explaining why each user's status could not be changed.
    - `field` string — The field that caused the error.
    - `reason` string — A description of why the user operation failed.
    - `userId` string, required — The user ID associated with the failed operation.

## Other responses

- `480` — ValidationError
- `481` — BadRequestError
- `482` — ResourceNotFoundError
- `483` — ForbiddenError
- `484` — UnauthorizedError
- `485` — InternalServerError
- `486` — RateLimitError

---

[API](https://skmtc.net/aws/apis/wickr.md) · [All operations](https://skmtc.net/aws/apis/wickr/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/wickr/revisions/71d396c2af63/schema)
