Skip to main content
PATCH
Update 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]+$

Body

application/json
name
string

A new name.

Required string length: 1 - 200
listIds
string[]

The campaign's lists, replacing the ones it has, 1 to 10. A running campaign does not enroll a new list's people: add a list with POST /v1/campaigns/{campaignId}/lists for that.

Required array length: 1 - 10 elements
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 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.