Block or Unblock Users

Use this method to block (that is, deactivate) a user or unblock, or activate, them.

Permissions: INTEGRATOR, SUPERVISOR

PathDescription
userVariableNamePossible values: id/login – user variable. Default: id

Request Body Parameters

ParameterTypeDescription
activeboolean (required)Activity state of the user (true – active/not blocked, false – not active/blocked)

Curl Example

$ curl 'http://localhost:8080/api/v1/users/123' -i -X PATCH \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <integrator_token>' \
  -d '{
  "active" : false
}'


HTTP Request

PATCH /api/v1/users/123 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 22
Host: localhost:8080
{
  "active" : false
}

Example of a Successful HTTP Response

HTTP/1.1 200 OK