Skip to main content
The ColdSend Public API uses API keys for authentication. All requests must include a valid API key in the X-API-Key header.

Authentication Method

Include your API key in every request:
import requests

api_key = "cs_live_your_api_key_here"
headers = {"X-API-Key": api_key}

response = requests.get(
    "https://api.coldsend.pro/api/public/v1/campaigns",
    headers=headers
)

Authentication Errors

{
  "detail": "API key required. Include your API key in X-API-Key header."
}
Status: 401 Unauthorized
{
  "detail": "Invalid or revoked API key"
}
Status: 401 Unauthorized
{
  "detail": "Missing required scopes: campaigns:write",
  "required": ["campaigns:write"],
  "granted": ["sender_accounts:read"]
}
Status: 403 ForbiddenThis error occurs when your API key lacks the required scope. See API Key Scopes for details.

Best Practices

  1. Store API keys securely — Use environment variables or a secrets manager. Never hardcode them.
  2. Use granular scopes — Create API keys with minimal required scopes for each integration.
  3. Monitor key usage — Review which keys are being used and revoke unused ones.
  4. Implement error handling — Handle HTTP 401 and 403 responses gracefully.

Next Steps

Create API Keys

How to create and manage API keys.

API Key Scopes

Understand granular permissions.