Skip to main content
POST
Create a draft campaign

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Body

application/json
campaignName
string
required
Required string length: 1 - 200
listId
string
listIds
string[]
Required array length: 1 - 10 elements
channels
enum<string>[]
Required array length: 1 - 10 elements
Available options:
email,
linkedin_connection,
linkedin_message,
inmail
campaignStartDate
string
timezone
string
default:UTC
emailDays
enum<string>[]
Required array length: 1 - 7 elements
Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
excludeLists
string[]
Maximum array length: 10
excludeCompanyLists
string[]
Maximum array length: 20
excludeContacted
enum<string>
default:none
Available options:
none,
ever,
last_1_month,
last_3_months,
last_6_months,
last_1_year
excludeEngagedContacts
boolean
default:false
isDynamic
boolean
default:false
useLinkedinPosts
boolean
default:false
openRateTrackingEnabledAt
string | null
delegates
string[]
campaignType
enum<string>
default:manual
Available options:
ai-generated,
manual
templateId
string | null
userPrompt
string | null
Maximum string length: 5000
websiteUrls
string[]
Maximum array length: 10
Maximum string length: 2000
additionalInfo
string
Maximum string length: 10000
Maximum string length: 2000
writingStyleId
string | null
knowledgeHubId
string

Response

Success

The response is of type object.