Sign in

v2

latestOpenAPI 3.1.02026-07-267085761.0 MB
Platform Users

Update User Status

Updates the status of a user.

Use this endpoint to change a user's account status, such as activating, suspending, or restricting access. This is typically used to manage user access, enforce compliance actions, or respond to risk-related events.

The update takes effect immediately and applies to the specified user.

patch/api/platform/users/status/{user_id}

Path parameters

user_idstring uuid required

Unique identifier (UUID) of the user whose account is being deleted.

Unique identifier (UUID) of the user whose account is being deleted.

Headers

X-Platform-IDstring uuid required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signaturestring required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Request body

status'normal' | 'safe' | 'flagged' | 'blocked' | 'deleted' required

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

A short, human-readable message describing the result of the request.

{"stackTrail":"components:schemas:CommonResponse:properties:data:anyOf","oasType":"schema","type":"unknown","title":"Data","description":"The main response payload, if applicable","nullable":true}
queryGeneratedTimenumber nullable

The Unix timestamp (in seconds) indicating when the response was generated.

Example response

{
  "success": true,
  "message": "Operation completed.",
  "queryGeneratedTime": 1718006400
}