Skip to main content
DELETE
/
users
/
{id}
Delete a user
curl --request DELETE \
  --url https://api.steuerboard.com/v1/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-id: <x-client-id>'
{
  "object": "file",
  "deleted": true,
  "id": "cmf41ajzv003706un4i99q19z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Headers

​
x-client-id
string<cuid>
required

The ID of the client

Example:

"cmf41ajzv003706un4i99q19z"

Path Parameters

​
id
string<cuid>
required

The ID of the item

Example:

"cmf41ajzv003706un4i99q19z"

Response

User deleted

​
object
string
required

The type of the deleted object

Example:

"file"

​
deleted
boolean
required

Whether the object was deleted

Example:

true

​
id
string<cuid>
required

The ID of the deleted object

Example:

"cmf41ajzv003706un4i99q19z"