Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Body

application/json
name
string
required

The campaign's name.

Required string length: 1 - 200
Example:

"Portugal freight ops"

listIds
string[]
required

1 to 10 of your people lists. Their people are enrolled once each, in the order the lists are given, when the campaign launches.

Required array length: 1 - 10 elements
Required string length: 24
Pattern: ^[0-9a-fA-F]+$
type
enum<string>

manual (the default): you write every step. ai-generated: the steps are written from prompt in the background.

Available options:
manual,
ai-generated
channels
enum<string>[]

One empty step is made for each channel, in order: email, linkedin_connection (an invitation), linkedin_message (to a connection) or inmail. ["email"] when left out. At most one linkedin_connection, before every linkedin_message. Not with templateId.

Required array length: 1 - 10 elements
Available options:
email,
linkedin_connection,
linkedin_message,
inmail
templateId
string

A campaign template whose steps are copied into the campaign; they decide its channels, so send no channels with it.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
prompt
string

ai-generated only: what you offer and to whom, up to 5,000 characters. The steps are written from it.

Maximum string length: 5000
writingStyleId
string

ai-generated only: the writing style the steps follow. Your default style when left out.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
knowledgeHubId
string

ai-generated only: the knowledge hub the steps draw on. Your default hub when left out.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
startDate
string

When sending may start, as an ISO 8601 date-time. Now when left out.

timezone
string

The IANA time zone the sending days and hours (9:00 to 17:00) are read in, such as Europe/Lisbon: a region, not an abbreviation such as EST. UTC when a campaign is created without one.

emailDays
enum<string>[]

The days messages may go out, by English name with a capital first letter. Monday to Friday when left out.

Required array length: 1 - 7 elements
Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
excludeLists
string[]

Up to 10 people lists whose people are never enrolled, matched by person, email address or LinkedIn profile. An id that is not one of your lists excludes nobody.

Maximum array length: 10
Required string length: 24
Pattern: ^[0-9a-fA-F]+$
excludeCompanyLists
string[]

Up to 20 company or people lists: nobody who works at one of their companies is enrolled. A list the organization does not have answers 422 exclude_company_lists_invalid.

Maximum array length: 20
Required string length: 24
Pattern: ^[0-9a-fA-F]+$
excludeContacted
enum<string>

Skips people your campaigns already wrote to: none (the default) skips nobody, ever skips everyone written to, and last_1_month to last_1_year skip those written to in that time.

Available options:
none,
ever,
last_1_month,
last_3_months,
last_6_months,
last_1_year
excludeEngagedContacts
boolean

Skips people who replied to one of your campaigns. False when left out.

isDynamic
boolean

Enrolls people added to the campaign's lists after launch, as they arrive. False when left out.

Ends every email with a one-click unsubscribe link. True when left out.

openRateTrackingEnabledAt
string

Turns open tracking on from this ISO 8601 date-time, or off with null. Off when left out.

clickTrackingEnabledAt
string

Turns click tracking on from this ISO 8601 date-time, or off with null. Off when left out. A step that waits for a click needs it on.

sendOnlyToValidatedEmailsEnabledAt
string

From this ISO 8601 date-time, enrolls only people whose email address checked valid; null also enrolls catch-all and unchecked addresses.

dailyEmailLimit
integer

The most emails the campaign sends a day, 1 to 10,000, or null for no limit.

Required range: 1 <= x <= 10000
dailyLinkedinConnectionLimit
integer

The most LinkedIn invitations the campaign sends a day, 1 to 10,000, or null for no limit.

Required range: 1 <= x <= 10000
dailyLinkedinMessageLimit
integer

The most LinkedIn messages and InMails the campaign sends a day, 1 to 10,000, or null for no limit.

Required range: 1 <= x <= 10000

The link steps insert where they write {CTA Link}: an http or https URL, or null or empty for none.

Maximum string length: 2000

Response

The new campaign, a draft: initializing until it is launched.

id
string
required
status
string
required