Sign in
Users

Suspend a user

Suspending a user prevents the user from signing in. Users that are suspended are also not counted against billing totals in the hosted version.

post/users.suspend

Request body

idstring uuid required

Unique identifier for the user.

Response

OK

Example response

{
  "data": {
    "name": "Jane Doe"
  }
}

Changes

Changed in 2 of the 6 revisions of this API.10

  • fdf2ec9c9df41See the full diff
    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • 7b33b538cd7d9See the full diff
    • ○

      added the optional property data to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property data to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property data to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 404 status

      response-optional-property-added