Campaigns

List campaigns

get

Lists all campaigns for the authenticated user's space with optional filtering by status and folder. Supports pagination.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Query parameters

pageintegerOptional

Page number (default: 1)

statusstring · enumOptional

Filter by status

Possible values:

folderIdintegerOptional

Filter by folder ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

List of campaigns

application/json

hasMorebooleanOptional

limitintegerOptional

pageintegerOptional

totalintegerOptional

400

Invalid query parameters

application/json

401

Unauthorized - invalid or missing API key

application/json

500

Failed to retrieve campaigns

application/json

get

/campaigns

HTTPcURLJavaScriptPython

GET /r/campaigns HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "campaigns": [
    {
      "createdAt": "text",
      "emoji": "text",
      "flow": "text",
      "id": 1,
      "name": "text",
      "stats": {
        "bouncedLeadsCount": 1,
        "contactedLeadsCount": 1,
        "emailsSentCount": 1,
        "leadsRespondedPositivelyCount": 1,
        "repliedLeadsCount": 1,
        "senderEmailsConnected": 1,
        "senderEmailsDisconnected": 1,
        "senderEmailsTotal": 1
      },
      "status": "text",
      "updatedAt": "text"
    }
  ],
  "hasMore": true,
  "limit": 1,
  "page": 1,
  "total": 1
}

Get a campaign by ID

get

Retrieves detailed information about a specific campaign including settings, schedule, statistics, and email counts.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Campaign ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

Campaign details

application/json

createdAtstringOptionalExample: 2024-01-10T10:30:00Z

emojistringOptionalExample: 🚀

flowstringOptionalExample: multiple_leads_scheduled

idintegerOptionalExample: 123

launchAtstringOptionalExample: 2024-01-15T09:00:00Z

namestringOptionalExample: Q1 Outreach Campaign

sendAtstringOptionalExample: 2024-01-15T10:00:00Z

statusstringOptionalExample: running

timezonestringOptionalExample: America/New_York

updatedAtstringOptionalExample: 2024-01-15T10:30:00Z

400

Invalid campaign ID

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Campaign not found

application/json

500

Failed to retrieve campaign

application/json

get

/campaigns/{id}

HTTPcURLJavaScriptPython

GET /r/campaigns/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "createdAt": "2024-01-10T10:30:00Z",
  "emails": {
    "blocked": 2,
    "bounced": 20,
    "canceled": 15,
    "catchAll": 12,
    "deferred": 5,
    "delivered": 280,
    "draft": 20,
    "dropped": 3,
    "errorOnSent": 5,
    "followUp": 50,
    "followUpCanceled": 10,
    "followUpDraft": 10,
    "invalid": 8,
    "pending": 100,
    "replied": 50,
    "scheduled": 500,
    "sent": 300,
    "spamReport": 2,
    "total": 1000,
    "waitingForReschedule": 5
  },
  "emoji": "🚀",
  "flow": "multiple_leads_scheduled",
  "id": 123,
  "launchAt": "2024-01-15T09:00:00Z",
  "name": "Q1 Outreach Campaign",
  "schedule": {
    "cronSchedule": "0 9 * * 1-5",
    "daysSchedule": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "endSchedule": "17:00",
    "everySchedule": 30,
    "startSchedule": "09:00"
  },
  "sendAt": "2024-01-15T10:00:00Z",
  "settings": {
    "allowNonBusinessEmails": false,
    "ignoreOutOfOfficeReplies": true,
    "isEnabledCatchallValidated": true,
    "isEnabledEmailVerifier": false,
    "isEnabledIgnoreHardBouncedLeads": true,
    "isEnabledIgnoreLeadsWhoAlreadyResponded": true,
    "isEnabledLlm": true,
    "isEnabledSkipLeadIfAlreadyExists": false,
    "isEnabledStopFollowUpsForSameCompany": false,
    "isEnabledStopFollowUpsOnReply": true,
    "maximumSendingLimitPerSenderEmail": 50,
    "maximumSendingLimitPerSenderEmailVariation": 10
  },
  "stats": {
    "bouncedLeadsCount": 1,
    "contactedLeadsCount": 1,
    "emailsSentCount": 1,
    "leadsRespondedPositivelyCount": 1,
    "repliedLeadsCount": 1,
    "senderEmailsConnected": 1,
    "senderEmailsDisconnected": 1,
    "senderEmailsTotal": 1
  },
  "status": "running",
  "timezone": "America/New_York",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Update a campaign by ID

put

Updates campaign properties such as name, emoji, timezone, and various settings. Only provided fields will be updated.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Campaign ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Body

application/json

allowNonBusinessEmailsbooleanOptional

emojistring · min: 1 · max: 10Optional

ignoreOutOfOfficeRepliesbooleanOptional

isEnabledCatchallValidatedbooleanOptional

isEnabledEmailVerifierbooleanOptional

isEnabledIgnoreHardBouncedLeadsbooleanOptional

isEnabledIgnoreLeadsWhoAlreadyRespondedbooleanOptional

isEnabledLlmbooleanOptional

Settings - all optional boolean flags

isEnabledSkipLeadIfAlreadyExistsbooleanOptional

isEnabledStopFollowUpsForSameCompanybooleanOptional

isEnabledStopFollowUpsOnReplybooleanOptional

maximumSendingLimitPerSenderEmailinteger · min: 1 · max: 10000Optional

maximumSendingLimitPerSenderEmailVariationinteger · max: 100Optional

namestring · min: 1 · max: 255Optional

timezonestringOptional

Responses

200

Campaign updated successfully

application/json

messagestringOptionalExample: campaign updated successfully

400

Invalid campaign ID or request body

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Campaign not found

application/json

500

Failed to update campaign

application/json

put

/campaigns/{id}

HTTPcURLJavaScriptPython

PUT /r/campaigns/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 486

{
  "allowNonBusinessEmails": true,
  "emoji": "text",
  "ignoreOutOfOfficeReplies": true,
  "isEnabledCatchallValidated": true,
  "isEnabledEmailVerifier": true,
  "isEnabledIgnoreHardBouncedLeads": true,
  "isEnabledIgnoreLeadsWhoAlreadyResponded": true,
  "isEnabledLlm": true,
  "isEnabledSkipLeadIfAlreadyExists": true,
  "isEnabledStopFollowUpsForSameCompany": true,
  "isEnabledStopFollowUpsOnReply": true,
  "maximumSendingLimitPerSenderEmail": 1,
  "maximumSendingLimitPerSenderEmailVariation": 1,
  "name": "text",
  "timezone": "text"
}

{
  "campaign": {
    "emoji": "🚀",
    "id": 123,
    "name": "Q1 Outreach Campaign"
  },
  "message": "campaign updated successfully"
}

Delete a campaign

delete

Deletes a campaign and all associated data including emails, sequences, and scheduled tasks.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Campaign ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

Campaign deleted successfully

application/json

idintegerOptionalExample: 123

messagestringOptionalExample: campaign deleted successfully

400

Invalid campaign ID

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Campaign not found

application/json

500

Failed to delete campaign

application/json

delete

/campaigns/{id}

HTTPcURLJavaScriptPython

DELETE /r/campaigns/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "id": 123,
  "message": "campaign deleted successfully"
}

Launch or resume a campaign

post

Launches a new campaign or resumes a paused campaign. Validates campaign configuration before launching.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Campaign ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

Campaign launched/resumed successfully

application/json

messagestringOptionalExample: campaign launched/resumed successfully

400

Campaign validation failed (missing configuration)

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Campaign not found

application/json

409

Campaign is currently processing leads

application/json

500

Failed to launch/resume campaign

application/json

post

/campaigns/{id}/launch

HTTPcURLJavaScriptPython

POST /r/campaigns/{id}/launch HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "campaign": {
    "id": 123,
    "name": "Q1 Outreach Campaign",
    "status": "running"
  },
  "message": "campaign launched/resumed successfully"
}

Pause a campaign

post

Pauses a running campaign and cancels all scheduled emails.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Campaign ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

Campaign paused successfully

application/json

messagestringOptionalExample: campaign paused successfully

400

Invalid campaign ID

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Campaign not found

application/json

500

Failed to pause campaign

application/json

post

/campaigns/{id}/pause

HTTPcURLJavaScriptPython

POST /r/campaigns/{id}/pause HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "campaign": {
    "id": 123,
    "name": "Q1 Outreach Campaign",
    "status": "paused"
  },
  "message": "campaign paused successfully"
}

Update campaign schedule

put

Updates the sending schedule for a campaign including timezone, days, time windows, and frequency.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Campaign ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Body

application/json

daysSchedulestring[]Optional

For multiple leads scheduled campaigns (flow 3) and API campaigns

endSchedulestringOptional

everyScheduleinteger · min: 1Optional

sendAtstringOptional

For single lead scheduled campaigns (flow 2)

startSchedulestringOptional

timezonestringRequired

Common field for all flows

Responses

200

Campaign schedule updated successfully

application/json

messagestringOptionalExample: campaign schedule updated successfully

400

Invalid request body or schedule configuration

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Campaign not found

application/json

500

Failed to update campaign schedule

application/json

put

/campaigns/{id}/schedule

HTTPcURLJavaScriptPython

PUT /r/campaigns/{id}/schedule HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "daysSchedule": [
    "text"
  ],
  "endSchedule": "text",
  "everySchedule": 1,
  "sendAt": "text",
  "startSchedule": "text",
  "timezone": "text"
}

{
  "campaign": {
    "daysSchedule": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "endSchedule": "17:00",
    "everySchedule": 30,
    "id": 123,
    "name": "Q1 Outreach Campaign",
    "startSchedule": "09:00",
    "timezone": "America/New_York"
  },
  "message": "campaign schedule updated successfully"
}