Skip to main content
PUT
/
api
/
users
/
{id}
/
inactivate
Inactivate the given user.
curl --request PUT \
  --url https://api.example.com/api/users/{id}/inactivate \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

Response

200 - application/json

The user has been inactivated successfully.