How to get your API key?

To generate your own ColdCampaigns API key please click on Settings menu and select the "API key" option on the left side or navigate here.

Endpoint structure

Each API endpoint call must contain the following:

  • A valid endpoint URL
    - Consists of the following:
    - Base URL
    - Version number
    - Endpoint
    - Endpoint variables (optional, depending on endpoint)

- Example:

  • Proper request header
    - Request header must contain the generated API key in the "x-api-key" variable

  • Proper request parameters
    - Optional
    - Depends on which endpoint is called
    - Parameters must be valid against the validation rules set by the endpoint
    validation rules

Did this answer your question?