Deactive a user

Deactivate a user. Perform this operation only on users with an Active status. We send a deactivation email to the user, and they will have an Inactive status when the deactivation process is complete.

Deactivate a user

post

Path parameters

idstringRequired

The id of the user.

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

403

The user's access was denied.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/users/{id}/deactivate HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}