Skip to main content
POST
/
v1
/
app
/
user
/
{userId}
/
deactivate
Deactivate user
curl --request POST \
  --url https://{base_url}/v1/app/user/{userId}/deactivate \
  --header 'Content-Type: application/json' \
  --data '"<unknown>"'
{
  "id": "<string>",
  "org_id": "<string>",
  "account_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "state": "Active",
  "roles": [
    "AppGuest"
  ],
  "created_at": "<string>",
  "profile_picture": "<string>",
  "job_position_name": "<string>",
  "job_position_description": "<string>"
}

Path Parameters

​
userId
string
required

The ID of the user to deactivate

Body

application/json

No body required for this operation

Nothing

Response

200 - application/json

Returns the deactivated user details

​
id
string
required
​
org_id
string
required
​
account_id
string
required
​
name
string
required
​
email
string
required
​
state
enum<string>
required
Available options:
Active,
Inactive
​
roles
enum<string>[]
required
Available options:
AppGuest,
AppMember,
AppAdmin,
AppOwner,
Basic,
Developer,
Admin,
SuperAdmin
​
created_at
string
required
​
profile_picture
string
​
job_position_name
string
​
job_position_description
string