DELETE Staff

Production

DELETE

/staff/{id}{format}

Permanently deletes a staff member. Requires the Edit Staff permission.

A staff member who has linked transactions cannot be deleted — disable the account instead. Returns 200 on success.

Request

Path Params

Header Params

🟢200OK

application/json

Staff member deleted successfully.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/staff/3' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "message": "Staff has been deleted"
}