Remove User via API

This method allows you to remove a user from your DeployHQ account.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/users/:identifier

HTTP Method

DELETE

Supported Parameters

This endpoint does not accept any parameters. The user identifier (UUID) is specified in the URL.

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-X DELETE \
https://test.deployhq.com/users/9e11def8-8c43-454e-8c99-3c5b9cf08396

Example Response

A successful deletion returns an HTTP 200 status:

{
  "status": "ok"
}

If you attempt to remove the account administrator, the API returns HTTP 403:

{
  "error": "Cannot remove the account administrator",
  "error_code": "forbidden"
}

Notes

• The :identifier in the URL is a UUID that uniquely identifies the user
• You cannot remove the account administrator
• This action is irreversible - the user will immediately lose access to the account
• To re-add a removed user, you will need to send a new invitation