Skip to main content
GET
Get a campaign

Authorizations

Authorization
string
header
required

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

Path Parameters

campaignId
string
required

The campaign's id.

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

Response

The campaign, with its settings under the names POST /v1/campaigns takes them. A field without a value is absent.

id
string
required
name
string
type
enum<string>
Available options:
manual,
ai-generated
status
enum<string>
Available options:
initializing,
active,
stopped,
paused_manual,
initialization_failed
initializationStatus
string

How writing an ai-generated campaign stands: pending, analyzing_prompt, building_knowledge, generating_topics, then completed or failed. A manual campaign is completed from the start.

listIds
string[]
startDate
string<date-time>

Nothing is sent before it.

timezone
string

The IANA time zone its sending days and hours (9:00 to 17:00) are read in.

emailDays
enum<string>[]

The days messages may go out.

Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
excludeLists
string[]

People lists whose people are never enrolled.

excludeCompanyLists
string[]

Lists whose companies' people are never enrolled.

excludeContacted
enum<string>

The people your campaigns already wrote to that are skipped: none, ever, or those written to in the time named.

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

People who replied to one of your campaigns are skipped.

isDynamic
boolean

People added to its lists after launch are enrolled as they arrive.

Every email ends with a one-click unsubscribe link.

openRateTrackingEnabledAt
string<date-time>

Since when opens are tracked. Absent while open tracking is off.

clickTrackingEnabledAt
string<date-time>

Since when links are tracked. Absent while click tracking is off.

dailyEmailLimit
integer
dailyLinkedinConnectionLimit
integer
dailyLinkedinMessageLimit
integer

The link steps insert where they write {CTA Link}. Absent when there is none.