ColdCampaigns API endpoints

Base URL

https://api.coldcampaigns.com/

Authentication

ColdCampaigns API uses api keys to authenticate the requests.

  • Firstly login to ColdCampaigns and generate an API key in Settings -> API menu.

  • The generated API key needs to be used to make a request.

  • The generated API key has to be sent in the request header in the "x-api-key" variable

Requests and responses

  • Request parameters (body) have to be JSON

  • Response format is also JSON

Versions

Current version: v1

List of endpoints

Ping the API

GET

ping

Ping the API

GET

mailing-lists

Get the ColdCampaigns API-key holder account's "Contacts" lists

GET

mailing-lists/{id}

Get information about a specific "Contacts" list of the API-key holder account

POST

mailing-lists

Create a new "Contacts" list for the API-key holder account

DELETE

mailing-lists/{id}

Delete a "Contacts" list from the API-key holder account

PUT

mailing-lists/{id}

Update a specific "Contacts" list of the API-key holder account

PUT

mailing-lists/{id}/statuses

Update statuses of a specific "Contacts" list of the API-key holder account

"Contacts" list ENTRY related endpoints

GET

mailing-lists/{mailingListId}/entries

Get contact list entries of a specific "Contacts" list

GET

mailing-lists/{mailingListId}/entries/{id}

Get a specific contact list entry from a specific "Contacts" list

POST

mailing-lists/{mailingListId}/entries

Create a new contact list entry in a specific "Contacts" list

DELETE

mailing-lists/{mailingListId}/entries/{id}

Delete a specific contact list entry in a "Contacts" list

PUT

mailing-lists/{mailingListId}/entries/{id}

Update a specific contact list entry in a specific "Contacts" list

Did this answer your question?