Skip to main content
POST
/
api
/
v1
/
campaign
Create new Campaign
curl --request POST \
  --url https://api.example.com/api/v1/campaign/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": 123
}
'
{
  "uid": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "workspace_id": 123,
  "settings": {
    "name": "<string>",
    "sending_domains": [
      "<string>"
    ],
    "reply_to_address": "<string>",
    "daily_email_limit": 1073741823,
    "skip_days": "<unknown>",
    "single_subject": true,
    "scheduling_strategy": "testing",
    "from_time": "<string>",
    "to_time": "<string>",
    "time_zone": "<string>",
    "add_unsub_link": true,
    "unsub_link_type": "<string>",
    "custom_unsub_text": "<string>",
    "click_tracking_enabled": true,
    "open_tracking_enabled": true,
    "skip_dangerous_emails": true,
    "skip_disposable_emails": true,
    "skip_catchall_emails": true,
    "skip_full_inbox_emails": true,
    "skip_invalid_emails": true
  },
  "selected_contact_lists": [
    "<string>"
  ],
  "scheduled_start_datetime": "2023-11-07T05:31:56Z",
  "status": "creating",
  "bounces": 1073741823,
  "campaign_paused": true,
  "campaign_paused_on": "2023-11-07T05:31:56Z",
  "is_generating_schedules": true,
  "is_deleting_schedules": true,
  "archived": true,
  "is_campaign_bounce_blocked": true,
  "started_running_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "cancelled_at": "2023-11-07T05:31:56Z"
}

Body

workspace_id
integer
required

Response

uid
string
required
Maximum string length: 255
created_on
string<date-time>
required
workspace_id
integer | null
required
settings
object
required

!!!IMPORTANT: Only fields that can be edited via campaign update api should be present here.

All other fields should be added to GetCampaignAPISerializer directly or via some other serializer.

selected_contact_lists
string[]
required
scheduled_start_datetime
string<date-time> | null
status
enum<string>
  • creating - Creating
  • created - Created
  • scheduled - Scheduled
  • running - Running
  • paused - Paused
  • complete - Complete
  • cancelled - Cancelled
  • failed - Failed
Available options:
creating,
created,
scheduled,
running,
paused,
complete,
cancelled,
failed
bounces
integer
Required range: 0 <= x <= 2147483647
campaign_paused
boolean
campaign_paused_on
string<date-time> | null
is_generating_schedules
boolean
is_deleting_schedules
boolean
archived
boolean
is_campaign_bounce_blocked
boolean
started_running_at
string<date-time> | null
completed_at
string<date-time> | null
cancelled_at
string<date-time> | null