clients
Purge client
Changed onPOST /api/v1/clients/{id}/purge
Handles purging a client.
❗ Note This is a destructive action. This action will remove all data associated with the client and cannot be undone.
post/api/v1/clients/{id}/purge
Request
- Base URLhttps://demo.invoiceninja.com
- Authnone declared. Required headers: X-API-TOKEN, X-Requested-With, X-API-PASSWORD
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring string required
The Client Hashed ID
Headers
X-API-TOKENstring required
Example:TOKEN
The API token to be used for authentication
X-Requested-Withstring required
Example:XMLHttpRequest
Used to send the XMLHttpRequest header
X-API-PASSWORDstring required
Example:supersecretpassword
The login password when challenged on certain protected routes
Response
Returns the client object
Changes
- warning
deleted the
queryrequest parameterinclude
- warning
- breaking
the response's body type changed from no type to
objectfor status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- breaking