Skip to main content
DELETE
/
users
/
{user_id}
Soft Delete User
curl --request DELETE \
  --url https://example.com/api/users/{user_id} \
  --header 'Authorization: Bearer <token>'
{
  "username": "<string>",
  "user_email": "<string>",
  "id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "added_by_uid": 123,
  "updated_by_uid": 123,
  "active": true,
  "group_id": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
user_id
integer
required

Response

Successful Response

​
username
string
required
​
role
enum<string>
required
Available options:
admin,
user,
readonly
​
user_email
string
required
​
id
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
added_by_uid
integer | null
required
​
updated_by_uid
integer | null
required
​
active
boolean
default:true
​
group_id
integer | null