Skip to main content
DELETE
/
v1
/
system
/
users
/
{type}
/
{id}
Delete User
curl --request DELETE \
  --url https://{base_url_domain}/api/global/v1/system/users/{type}/{id} \
  --header 'Authorization: Bearer <token>'
{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

ā€‹
type
enum<string>
required

Specify the user type to which your operations will be restricted.

Available options:
any,
organization,
client
ā€‹
id
integer<int32>
required

The id of the referenced User.

Required range: x >= 1

Response

OK - The operation completed successfully and there is no response body.