curl -X POST "https://server.smartlead.ai/api/v1/client/api-key?api_key=YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"clientId": 301, "keyName": "Production Key"}'
{
"ok": true,
"data": {
"id": 45,
"client_id": 301,
"key_name": "Production Key",
"api_key": "cl_live_xxxxxxxxxxxxxxxx",
"status": "active",
"created_at": "2025-12-01T10:00:00.000Z"
}
}
{
"message": "Invalid API Key"
}
Client Management
Manage Client API Keys
Create, list, delete, and reset API keys for client sub-accounts
POST
/
api
/
v1
/
client
/
api-key
curl -X POST "https://server.smartlead.ai/api/v1/client/api-key?api_key=YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"clientId": 301, "keyName": "Production Key"}'
{
"ok": true,
"data": {
"id": 45,
"client_id": 301,
"key_name": "Production Key",
"api_key": "cl_live_xxxxxxxxxxxxxxxx",
"status": "active",
"created_at": "2025-12-01T10:00:00.000Z"
}
}
{
"message": "Invalid API Key"
}
Each client can have multiple API keys with custom names. Use these endpoints to manage programmatic access for your client sub-accounts.
Overview
Client API keys provide programmatic access to SmartLead on behalf of a specific client. You can create multiple keys per client, filter by status, and reset keys as needed. Available Operations:- Create: POST
/api/v1/client/api-key- Generate a new API key - List: GET
/api/v1/client/api-key- List all client API keys - Delete: DELETE
/api/v1/client/api-key/:id- Remove an API key - Reset: PUT
/api/v1/client/api-key/reset/:id- Regenerate an API key
Query Parameters
string
required
Your SmartLead API key
Request Body
number
required
The ID of the client to create the API key for
string
required
A descriptive name for the API key. Must match pattern: letters, numbers, spaces, hyphens, and underscores only.
List Client API Keys
GET https://server.smartlead.ai/api/v1/client/api-key
Query Parameters
string
required
Your SmartLead API key
number
Filter by client ID
string
Filter by key status. Values:
active, inactivestring
Filter by key name (partial match)
Delete Client API Key
DELETE https://server.smartlead.ai/api/v1/client/api-key/:id
Path Parameters
number
required
The ID of the API key to delete
Reset Client API Key
PUT https://server.smartlead.ai/api/v1/client/api-key/reset/:id
Path Parameters
number
required
The ID of the API key to reset. This generates a new key value while keeping the same key record.
curl -X POST "https://server.smartlead.ai/api/v1/client/api-key?api_key=YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"clientId": 301, "keyName": "Production Key"}'
Response Codes
Success
Request successful
Bad Request
Invalid request parameters or malformed request body
Unauthorized
Invalid or missing API key
Validation Error
Request validation failed. Check parameter types and constraints.
{
"ok": true,
"data": {
"id": 45,
"client_id": 301,
"key_name": "Production Key",
"api_key": "cl_live_xxxxxxxxxxxxxxxx",
"status": "active",
"created_at": "2025-12-01T10:00:00.000Z"
}
}
{
"message": "Invalid API Key"
}
