Campaigns

Campaign execution and analytics

Stats

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

get

/api/stats

HTTPcURLJavaScriptPython

GET /api/stats HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

{
  "total_campaigns": 1,
  "active_campaigns": 1,
  "paused_campaigns": 1,
  "archived_campaigns": 1,
  "scheduled_campaigns": 1,
  "total_targets": 1,
  "emails_sent_today": 1
}

List Campaigns

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

Responseany

get

/api/campaigns

HTTPcURLJavaScriptPython

GET /api/campaigns HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

No content

Create Campaign

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

namestringRequired

run_nowbooleanOptionalDefault: false

server_idintegerRequired

profile_idintegerRequired

template_idintegerRequired

list_idsinteger[]Required

use_batchesbooleanOptionalDefault: false

batch_sizeany ofOptional

integerOptional

or

nullOptional

batch_delay_secondsany ofOptional

integerOptional

or

nullOptional

custom_headersany ofOptional

or

nullOptional

scheduled_start_atany ofOptional

stringOptional

or

nullOptional

remove_duplicate_targetsbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/campaigns

HTTPcURLJavaScriptPython

POST /api/campaigns HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "name": "text",
  "run_now": false,
  "server_id": 1,
  "profile_id": 1,
  "template_id": 1,
  "list_ids": [
    1
  ],
  "use_batches": false,
  "batch_size": 1,
  "batch_delay_seconds": 1,
  "custom_headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "scheduled_start_at": "text",
  "remove_duplicate_targets": false
}

{
  "id": 1,
  "name": "text",
  "status": "text"
}

Campaign Detail

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/campaigns/{campaign_id}

HTTPcURLJavaScriptPython

GET /api/campaigns/{campaign_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": 1,
  "name": "text",
  "status": "text",
  "created_at": "text",
  "started_at": "text",
  "completed_at": "text",
  "scheduled_start_at": "text",
  "server": "text",
  "profile": "text",
  "profile_email": "text",
  "template": "text",
  "lists": [
    "text"
  ],
  "total": 1,
  "sent": 1,
  "failed": 1,
  "pending": 1,
  "custom_headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "use_batches": false,
  "batch_size": 1,
  "batch_delay_seconds": 1,
  "remove_duplicate_targets": false,
  "last_error": "text",
  "last_error_trace": "text",
  "last_error_at": "text",
  "has_calendar_invite": false,
  "has_calendar_reschedule": false,
  "has_calendar_cancellation": false,
  "calendar_uid": "text",
  "meeting_sequence": 1,
  "calendar_ics_prodid": "text",
  "meeting_summary": "text",
  "meeting_begin": "text",
  "meeting_end": "text",
  "meeting_tz": "text",
  "meeting_provider": "none",
  "meeting_url": "text"
}

Delete Campaign

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/api/campaigns/{campaign_id}

HTTPcURLJavaScriptPython

DELETE /api/campaigns/{campaign_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Campaign Targets Status

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/campaigns/{campaign_id}/targets_status

HTTPcURLJavaScriptPython

GET /api/campaigns/{campaign_id}/targets_status HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": 1,
    "first_name": "text",
    "last_name": "text",
    "email": "[e-mail]",
    "status": "text",
    "sent_at": "text",
    "error": "text",
    "opened": false,
    "opened_at": "text"
  }
]

Start Campaign

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/campaigns/{campaign_id}/start

HTTPcURLJavaScriptPython

POST /api/campaigns/{campaign_id}/start HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Pause Campaign

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/campaigns/{campaign_id}/pause

HTTPcURLJavaScriptPython

POST /api/campaigns/{campaign_id}/pause HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Resume Campaign

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/campaigns/{campaign_id}/resume

HTTPcURLJavaScriptPython

POST /api/campaigns/{campaign_id}/resume HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Archive Campaign

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/campaigns/{campaign_id}/archive

HTTPcURLJavaScriptPython

POST /api/campaigns/{campaign_id}/archive HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Schedule Campaign

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Body

application/json

object · PayloadOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/campaigns/{campaign_id}/schedule

HTTPcURLJavaScriptPython

POST /api/campaigns/{campaign_id}/schedule HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

No content

Unschedule Campaign

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/campaigns/{campaign_id}/unschedule

HTTPcURLJavaScriptPython

POST /api/campaigns/{campaign_id}/unschedule HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Campaign Logs

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/campaigns/{campaign_id}/logs

HTTPcURLJavaScriptPython

GET /api/campaigns/{campaign_id}/logs HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Campaign Variables

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/campaigns/{campaign_id}/variables

HTTPcURLJavaScriptPython

GET /api/campaigns/{campaign_id}/variables HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "static_vars": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "headers": [
    "text"
  ],
  "rows": [
    {
      "name": "text",
      "email": "[e-mail]",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Mark Opened

post

Path parameters

campaign_idintegerRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

Body

application/json

emailany ofOptional

string · emailOptional

or

nullOptional

var_nameany ofOptional

stringOptional

or

nullOptional

var_valueany ofOptional

stringOptional

or

nullOptional

openedbooleanOptionalDefault: true

bulkany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/campaigns/{campaign_id}/opened

HTTPcURLJavaScriptPython

POST /api/campaigns/{campaign_id}/opened HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "email": "[e-mail]",
  "var_name": "text",
  "var_value": "text",
  "opened": true,
  "bulk": true
}

{
  "updated": 1
}

Clear Campaign Error

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/campaigns/{campaign_id}/clear_error

HTTPcURLJavaScriptPython

POST /api/campaigns/{campaign_id}/clear_error HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Campaigns Calendar

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

Responseany

get

/api/campaigns_calendar

HTTPcURLJavaScriptPython

GET /api/campaigns_calendar HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

No content

Archive All Campaigns

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

Responseany

post

/api/campaigns/archive_all

HTTPcURLJavaScriptPython

POST /api/campaigns/archive_all HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

No content

User Campaigns

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Query parameters

emailstring · emailRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/user_campaigns

HTTPcURLJavaScriptPython

GET /api/user_campaigns?email=name%40gmail.com HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "date": "2025-12-27T20:38:14.547Z"
  }
]

Export Campaign Results

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

campaign_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/campaigns/{campaign_id}/export

HTTPcURLJavaScriptPython

GET /api/campaigns/{campaign_id}/export HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Delete All Archived Campaigns

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

Responseany

post

/api/campaigns/delete_all

HTTPcURLJavaScriptPython

POST /api/campaigns/delete_all HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

No content