Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
title
string | null
type
string | null
description
string | null
start_date
string | null
end_date
string | null
scheduled_at
string | null
timezone
string | null
venue
string | null
physical_address
string | null
partner_type_referral
boolean
partner_type_reseller
boolean
partner_type_distributor
boolean
enabled_modules
enum<string>[]

Modules to enable on the campaign. Only built modules may be enabled: details, schedule, recipients, partners, email, templates, forms, leads, settings. The legacy "audience" value is accepted and mapped to "recipients". Any other value (the reserved tags/notes/analytics/assets/mdf/social slots) is rejected with a validation error.

Available options:
details,
schedule,
partners,
audience,
recipients,
email,
templates,
forms,
tags,
notes,
leads,
analytics,
assets,
mdf,
social,
settings
email_template_uuid
string

Response

201 - application/json

Default Response

uuid
string
required
title
string | null
required
type
string | null
required
description
string | null
required
status
string
required
completed
boolean
required
lead_sharing_enabled
boolean
required
start_date
string | null
required
end_date
string | null
required
scheduled_at
string | null
required
timezone
string | null
required
venue
string | null
required
physical_address
string | null
required
partner_type_referral
boolean
required
partner_type_reseller
boolean
required
partner_type_distributor
boolean
required
email_status
enum<string> | null
required
Available options:
draft,
scheduled,
sending,
sent,
partial,
failed,
cancelled
enabled_modules
enum<string>[]
required

Modules enabled on the campaign, aliased to canonical names (the legacy "audience" value is always reported as "recipients", even if the row still stores "audience"). Built modules: details, schedule, recipients, partners, email, templates, forms, leads, settings. Reserved/roadmap values (tags, notes, analytics, assets, mdf, social) may also appear if already stored on the row.

Available options:
details,
schedule,
partners,
audience,
recipients,
email,
templates,
forms,
tags,
notes,
leads,
analytics,
assets,
mdf,
social,
settings
email_template
object | null
required
tags
object[]
required
created_at
string
required
updated_at
string
required
tiers
object[]
required
categories
object[]
required
stages
object[]
required
partners
object[]
required
recipient_partnerships
object[]
required
contact_tags
object[]
required
contacts
object[]
required