Campaigns
List campaigns
API Documentation
Status
Workspaces
Leads
- POSTCreate a lead
- GETGet a lead by id
- DELDelete a lead
- PATCHUpdate a lead
- POSTDelete many leads
- PATCHUpdate many leads
- POSTList leads with pagination and filters
- POSTAdd a list to leads
- POSTTrack a lead
- GETGet count of tracked leads
- POSTTrack leads
- POSTConnect a lead to a company
- POSTDisconnect a lead from a company
- POSTSearch leads
Lists
Campaigns
Reminders
Campaigns
List campaigns
GET
/
campaigns
curl --request GET \
--url https://api.breakcold.com/rest/campaigns \
--header 'X-API-KEY: <api-key>'
{
"data": [
{
"status": "RUNNING",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"icon": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"days": "<string>",
"end_hour": 123,
"end_min": 123,
"start_hour": 123,
"start_min": 123,
"time_between_send": 123,
"timezone": "<string>",
"job_id": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"start_date": "2023-11-07T05:31:56Z",
"unsubscribe_link": true,
"stop_sending_after_reply": true,
"track_open_rate": true,
"stop_sending_after_bounce": true,
"id_email_alias": 123,
"id_email_group": "<string>",
"id_space": "<string>"
}
],
"pagination": {
"count": 123,
"page": 123
}
}
Authorizations
Response
200
application/json
Successful response
Available options:
RUNNING
, PAUSED
, FINISHED
curl --request GET \
--url https://api.breakcold.com/rest/campaigns \
--header 'X-API-KEY: <api-key>'
{
"data": [
{
"status": "RUNNING",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"icon": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"days": "<string>",
"end_hour": 123,
"end_min": 123,
"start_hour": 123,
"start_min": 123,
"time_between_send": 123,
"timezone": "<string>",
"job_id": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"start_date": "2023-11-07T05:31:56Z",
"unsubscribe_link": true,
"stop_sending_after_reply": true,
"track_open_rate": true,
"stop_sending_after_bounce": true,
"id_email_alias": 123,
"id_email_group": "<string>",
"id_space": "<string>"
}
],
"pagination": {
"count": 123,
"page": 123
}
}