​
Authentication

To use Breakcold API, you need to authenticate yourself using your API key. You can find your API key on your Breakcold dashboard here Integrations settings.

Updated API Key Required for Some Endpoints

Please be advised that certain endpoints in the API documentation require the latest version of the API key. The new key version begins with “breakcold-usr”. To obtain the new key, please revoke your previous one.

Failure to update your API key may result in access failure or other issues. Thank you for your cooperation.

​
Header Parameters for Authentication with API Key

​
x-api-key
string
required

Your Breakcold API key.

{
  "method": "GET",
  "url": "https://api.breakcod.com/lead/123
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "YOUR_API_KEY_HERE"
  }
}

​
Endpoint

The endpoint for Breakcold API is https://api.breakcold.com/rest.

​
Rate Limit

The rate limit for Breakcold API is 60 requests per second. Please ensure that you do not exceed the limit to avoid any issues with your account.

​
Support

If you encounter any issues while using Breakcold API, please contact our support team at support@breakcold.com.

Thank you for choosing Breakcold! We hope that our API will help you achieve your goals.

​
Next Steps

Here are some next steps to help you get started with Breakcold API:

API reference

Our API reference provides information about our endpoints.

API key

Get my api key