SMTP CallBack
Overview
Creates a new SMTP user credential for the Bulk API service. This version is optimized for high-volume
operations and includes enhanced features for batch processing.
The Bulk API SMTP user creation includes:
- Higher default throughput limits
- Batch processing capabilities
- Campaign-level tracking
- Advanced scheduling options
Use this endpoint when setting up infrastructure for marketing campaigns, newsletters, or any scenario requiring thousands
Of emails per hour.
Endpoint Details
| HTTP Method | POST |
|---|---|
| Endpoint Path | /v2/settings/addSmtp |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
| total_limit | Integer | Yes | Maximum total emails allowed for this SMTP user. Acts as overall quota | 10000 |
| hourly_limit | Integer | Yes | Maximum emails per hour for this SMTP user. Controls sending rate | 100 |
Request Example
Below is a complete example of the request body. Replace placeholder values with your actual credentials and data.
{
"owner_id": "{{owner_id}}",
"smtp": "{{smtp_user_name}}",
"total_limit": 100000000000,
"hourly_limit": 150000
}Response Format
Successful Response:
{
"status": "success",
"code": 200,
"message": "Resource created successfully",
"data": {
"id": "resource_abc123",
"created_at": "2026-04-17T10:30:00Z"
}
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Implementation Examples
curl -X POST \
https://api.sendclean.com/v2/settings/addSmtp \
-H 'Content-Type: application/json' \
-d '{
"owner_id": "{{owner_id}}",
"smtp": "{{smtp_user_name}}",
"total_limit": 100000000000,
"hourly_limit": 150000
}'const axios = require('axios');
const url = 'https://api.sendclean.com/v2/settings/addSmtp';
const payload = {
"owner_id":"{{owner_id}}",
"smtp":"{{smtp_user_name}}",
"total_limit": 100000000000,
"hourly_limit": 150000
};
axios.post(url, payload, {
headers: {
'Content-Type': 'application/json'
}
})
.then(response => {
console.log('Success:', response.data);
})
.catch(error => {
console.error('Error:', error.response ? error.response.data : error.message);
});<?php
$url = 'https://api.sendclean.com/v2/settings/addSmtp';
$payload = json_decode('{
"owner_id":"{{owner_id}}",
"smtp":"{{smtp_user_name}}",
"total_limit": 100000000000,
"hourly_limit": 150000
}', true);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json'
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($httpCode == 200) {
$result = json_decode($response, true);
print_r($result);
} else {
echo "Error: $httpCode - $response";
}
?>Overview
Retrieves all Bulk API SMTP users with enhanced metadata for campaign management and batch processing
tracking.
Endpoint Details
| HTTP Method | GET |
|---|---|
| Endpoint Path | /v2/settings/listSmtp |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
Response Format
Successful Response:
{
"status": "success",
"code": 200,
"data": {
"items": [
{
"id": "item_001",
"created_at": "2026-04-01T09:00:00Z",
"status": "active"
}
],
"total": 1,
"page": 0
}
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Overview
Updates Bulk API SMTP user configuration with support for high-volume specific settings. This version
includes additional parameters for batch processing and campaign management.
Endpoint Details
| HTTP Method | PUT |
|---|---|
| Endpoint Path | /v2/settings/editSmtp |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
| total_limit | Integer | Yes | Maximum total emails allowed for this SMTP user. Acts as overall quota | 10000 |
| hourly_limit | Integer | Yes | Maximum emails per hour for this SMTP user. Controls sending rate | 100 |
| status | String | No | SMTP user status. Values: "Enable" to activate, "Disable" to pause | Enable |
Request Example
Below is a complete example of the request body. Replace placeholder values with your actual credentials and data.
{
"owner_id": "{{owner_id}}",
"smtp": "{{smtp_user_name}}",
"total_limit": 100000000000,
"hourly_limit": 150000,
"status": "Enable"
}Response Format
Successful Response:
{
"status": "success",
"code": 200,
"message": "Resource updated successfully",
"data": {
"updated_at": "2026-04-17T10:30:00Z"
}
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Overview
Resets the password for an SMTP user credential. This is a critical security operation that should
be performed:
- Immediately if credentials are compromised
- Periodically for security hygiene (recommended every 90 days)
- When rotating credentials between environments
- After employee turnover
After changing the password, you must update all applications using this SMTP user with the new credentials. The old password
becomes invalid immediately.
Endpoint Details
| HTTP Method | PUT |
|---|---|
| Endpoint Path | /v2/settings/resetSmtpPassword |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
Request Example
Below is a complete example of the request body. Replace placeholder values with your actual credentials and data.
{
"owner_id": "{{owner_id}}",
"smtp": "{{smtp_user_name}}"
}Response Format
Successful Response:
{
"status": "success",
"code": 200,
"message": "Operation completed successfully"
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Updated 2 months ago