Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchToggleUserSuspendStatus

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.

Request Syntax


PATCH /networks/networkId/users/toggleSuspend?suspend=suspend HTTP/1.1
X-Client-Token: clientToken
Content-type: application/json

{
   "userIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

clientToken

A unique identifier for this request to ensure idempotency.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-_:]+

networkId

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

Length Constraints: Fixed length of 8.

Pattern: [0-9]{8}

Required: Yes

suspend

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

userIds

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 10.

Pattern: [0-9]+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "failed": [ 
      { 
         "field": "string",
         "reason": "string",
         "userId": "string"
      }
   ],
   "message": "string",
   "successful": [ 
      { 
         "userId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failed

A list of suspend status toggle attempts that failed, including error details explaining why each user's status could not be changed.

Type: Array of BatchUserErrorResponseItem objects

message

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

Type: String

Pattern: [\S\s]*

successful

A list of user IDs whose suspend status was successfully toggled.

Type: Array of BatchUserSuccessResponseItem objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestError

The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.

message: A detailed message explaining what was wrong with the request and how to correct it.

HTTP Status Code: 400

ForbiddenError

Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.

message: A message explaining why access was denied and what permissions are required.

HTTP Status Code: 403

InternalServerError

An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact AWS Support.

message: A message describing the internal server error that occurred.

HTTP Status Code: 500

RateLimitError

The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.

message: A message indicating that the rate limit was exceeded and suggesting when to retry.

HTTP Status Code: 429

ResourceNotFoundError

The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.

message: A message identifying which resource was not found.

HTTP Status Code: 404

UnauthorizedError

The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.

message: A message explaining why the authentication failed.

HTTP Status Code: 401

ValidationError

One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.

reasons: A list of validation error details, where each item identifies a specific field that failed validation and explains the reason for the failure.

HTTP Status Code: 422