Users & Roles
API ReferenceUsersDelete
Delete User
Revokes a user's access to the merchant or organisation. The underlying account stays in the platform's user table for audit (the user can be re-invited later under the same email), but they immediately lose all permissions.
DELETE /user/user/delete
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | The user's email. |
Request Example
curl -X DELETE 'https://api.v2.paychtec.com/user/user/delete' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY" \ -d '{ "email": "bob@acme.com"}'Response
{
"email": "bob@acme.com",
"deleted": true
}Errors
| Status | When |
|---|---|
403 | You cannot delete a user whose role is higher than yours. |
404 | No user with that email in this scope. |