curl -X DELETE "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&confirm_email=client@acme.com"
curl -X DELETE "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&confirm_email=client@acme.com&downgradeClientAddOn=true"
import requests
response = requests.delete(
"https://server.smartlead.ai/api/v1/client/456",
params={"api_key": "YOUR_API_KEY", "confirm_email": "client@acme.com"}
)
print(response.json())
{
"ok": true,
"clientId": 456,
"apiKeysRevoked": 1
}
{
"message": "confirm_email does not match the client's email. Nothing was deleted."
}
{
"message": "Not authorized"
}
{
"message": "Invalid client id!"
}
{
"message": "You can't delete more clients subscription than the number of clients subscription you have as free in your plan."
}
You have exceeded the 5 requests in 60 sec limit for this endpoint!
{
"ok": false,
"message": "An internal server error occurred while deleting the client. Please retry after some time. If the issue persists, please contact support.",
"clientId": 456
}
Client Management
Delete Client
Permanently delete a client from your account
DELETE
/
api
/
v1
/
client
/
{id}
curl -X DELETE "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&confirm_email=client@acme.com"
curl -X DELETE "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&confirm_email=client@acme.com&downgradeClientAddOn=true"
import requests
response = requests.delete(
"https://server.smartlead.ai/api/v1/client/456",
params={"api_key": "YOUR_API_KEY", "confirm_email": "client@acme.com"}
)
print(response.json())
{
"ok": true,
"clientId": 456,
"apiKeysRevoked": 1
}
{
"message": "confirm_email does not match the client's email. Nothing was deleted."
}
{
"message": "Not authorized"
}
{
"message": "Invalid client id!"
}
{
"message": "You can't delete more clients subscription than the number of clients subscription you have as free in your plan."
}
You have exceeded the 5 requests in 60 sec limit for this endpoint!
{
"ok": false,
"message": "An internal server error occurred while deleting the client. Please retry after some time. If the issue persists, please contact support.",
"clientId": 456
}
Deletion is permanent and cannot be undone. The client can no longer log in, all of its API keys are revoked immediately, and it is unlinked from any SmartServers, servers and infrastructure it was assigned to. Clients with no API keys are deleted the same way.
This endpoint is limited to 5 requests per minute per account. Requests over the limit return
429.Path Parameters
number
required
ID of the client to delete. Must belong to your account.
Query Parameters
string
required
Your SmartLead API key (client API keys are not allowed)
string
required
Email address of the client you are deleting. It must match the email of the client with this
id on your account (case-insensitive). This guards against deleting the wrong client: on a mismatch the request returns 400 and nothing is deleted.boolean
default:"false"
Also reduce your paid client add-on subscription by one seat. Ignored for accounts with grandfathered whitelabel pricing. Rejected with
406 if it would take you below the clients included free in your plan.Rate Limit
| Limit | Scope | Window |
|---|---|---|
| 5 requests | Per account (all API keys of the account share it) | 60 seconds |
- Every request counts, including ones rejected for invalid parameters.
- Requests over the limit return
429until the window resets; retry after 60 seconds. - Your account’s general API rate limit still applies on top of this.
curl -X DELETE "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&confirm_email=client@acme.com"
curl -X DELETE "https://server.smartlead.ai/api/v1/client/456?api_key=YOUR_KEY&confirm_email=client@acme.com&downgradeClientAddOn=true"
import requests
response = requests.delete(
"https://server.smartlead.ai/api/v1/client/456",
params={"api_key": "YOUR_API_KEY", "confirm_email": "client@acme.com"}
)
print(response.json())
Response
boolean
true when the client was deletednumber
ID of the deleted client
number
Number of the client’s active API keys that were revoked (
0 if it had none){
"ok": true,
"clientId": 456,
"apiKeysRevoked": 1
}
{
"message": "confirm_email does not match the client's email. Nothing was deleted."
}
{
"message": "Not authorized"
}
{
"message": "Invalid client id!"
}
{
"message": "You can't delete more clients subscription than the number of clients subscription you have as free in your plan."
}
You have exceeded the 5 requests in 60 sec limit for this endpoint!
{
"ok": false,
"message": "An internal server error occurred while deleting the client. Please retry after some time. If the issue persists, please contact support.",
"clientId": 456
}