Skip to main content

Delete client

DELETE 
/api/v1/clients/:id

DELETE /api/v1/clients/{id}​

Handles the deletion of a client by id

❗ Note Deleting a client does not purge the client from the system. The delete action will remove the clients data from all views in the application but keep it on file in case it needs to be restored.

A Client can be later restored reversing this action.

To permanently wipe a client and all of their records from the system, use the /purge route

Request​

Responses​

Returns a HTTP status

Response Headers
    X-MINIMUM-CLIENT-VERSION

    The API version

    X-RateLimit-Remaining

    The number of requests left for the time window.

    X-RateLimit-Limit

    The total number of requests in a given time window.

Last updated on