SmartMatchApp

Delete Client

Delete a specific client.

This endpoint allows you to delete a specified client from the system. Once deleted, the client cannot be recovered.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/" \
  -u <token>: \
  -X DELETE
Example Success Response:
HTTP 204 No Content

This response indicates that the client was successfully deleted, with no content returned.

Base Request:

Method: DELETE

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

10 requests within 10 seconds

Error Responses:
401 Unauthorized

This error occurs when the <token> is missing, invalid, or the API access is disabled.

Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
404 Not Found

This error occurs if the client with the specified ID does not exist.
Possible errors: "client not found"
405 Method Not Allowed

This error occurs if an HTTP method other than DELETE is used (e.g., GET or PUT).
Possible errors: "wrong method"
429 Too Many Requests

This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server.

Possible errors: "too many requests"
500 Server Error

Possible errors: "Internal server error"