Skip to content

Delete an end-user

DELETE https://rest.haasapi.com/v1/partner/users/{user_id}

Soft-deletes an end-user and tears down its exchange account - the driver is stopped and the stored credentials are removed. Refused with 409 while the user still has bots: stop and delete them first. Answers 204 with no body. Naturally idempotent - deleting an already-removed user answers 404.

Requires the partner scope.

Terminal window
curl "https://rest.haasapi.com/v1/partner/users/{user_id}" \
-X DELETE \
-H "Authorization: Bearer hk_live_YOUR_KEY"

204 Deleted - no content.

All errors are RFC 9457 problem documents.

Status Description
400 The request is malformed (invalid limit, unusable cursor, …). (code: invalid_request)
401 Missing, malformed, disabled, or revoked API key. (code: invalid_api_key)
404 No accessible end-user with that id. (code: user_not_found)
409 The end-user still has bots; stop and delete them first. (code: user_has_bots)
500 An unexpected error inside the API. Nothing about the request caused it; retry, and quote the instance value if it persists. (code: internal_error)
502 An internal service answered in a way the API could not serve. Retry. (code: upstream_error)
503 The request could not be served right now. Retry with the same key - do not discard it. (code: temporarily_unavailable)
504 An internal service did not answer within the deadline. Retry with backoff. (code: upstream_timeout)
{
"type": "https://docs.haasapi.com/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"detail": "The request is malformed (invalid limit, unusable cursor, …).",
"code": "invalid_request"
}