Skip to main content
POST
Add a step to 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
channel
enum<string>
required

email, linkedin_connection (an invitation), linkedin_message (to a connection), linkedin_visit (a profile visit), linkedin_like (a like on a recent post), inmail, or condition: a branch that waits for conditionType and sends each lead down its yes or no lane, or for an ab_split, down variant a or b at once. A linkedin_connection step cannot follow a linkedin_message step.

Available options:
email,
linkedin_connection,
linkedin_message,
linkedin_visit,
linkedin_like,
inmail,
condition
sequenceNumber
integer
required

The step's place, from 0, in the main sequence or in the lane parentStepId and branchKey name. Send the length of the sequence or lane to add at its end; a taken place answers 409 step_position_taken.

Required range: 0 <= x <= 50
daysBetween
integer
required

Days to wait after the step before (or after the start, for the first step), 0 to 90. On a condition, how long it waits for its signal, 1 to 30 days; an ab_split waits for nothing: send 0.

Required range: 0 <= x <= 90
type
enum<string>

manual (the default) sends subject and body as written; ai_generated writes each message for each lead from a topic it writes itself; ai_reply drafts a reply from topic that waits for your approval. A condition is always manual.

Available options:
manual,
ai_generated,
ai_reply
subject
string

A manual step's subject line, up to 500 characters. Not on visits, likes and conditions.

Maximum string length: 500
body
string

A manual step's message, up to 20,000 characters; the tokens GET /v1/campaigns/{campaignId}/variables lists, such as {Contact First Name}, are filled in for each lead. On a linkedin_connection step, the invitation note, up to 200 characters. Not on visits, likes and conditions.

topic
string

What the step should say, up to 500 characters. Needed by ai_reply; ai_generated writes its own.

Required string length: 1 - 500
cc
string[]

Up to 10 addresses copied on every email of the step.

Maximum array length: 10
Maximum string length: 320
parentStepId
string

The condition whose lane the step goes in, with branchKey. Left out, the step goes in the main sequence.

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

The lane of parentStepId: yes or no under a condition, a or b under an A/B split.

Available options:
yes,
no,
a,
b,
null
conditionType
enum<string>

Conditions only: invite_accepted waits for the invitation of the nearest linkedin_connection step before it, clicked_link for a click in the nearest email before it, and ab_split splits leads between variants a and b by splitArms. Conditions can be added only before the campaign starts.

Available options:
invite_accepted,
clicked_link,
ab_split
splitArms
object[]

ab_split only: both variants, a then b, each { key, label?, weight }. 50 each when left out.

Required array length: 2 elements

Response

The new step.

id
string
required
channel
enum<string>
Available options:
email,
linkedin_connection,
linkedin_message,
linkedin_visit,
linkedin_like,
inmail,
condition
type
enum<string>
Available options:
manual,
ai_generated,
ai_reply
sequenceNumber
integer

Its place, from 0, in the main sequence or its lane.

daysBetween
integer

Days after the step before. On a condition, its window.

title
string
topic
string
subject
string
body
string

On a linkedin_connection step, the invitation note.

cc
string[]
parentStepId
string

The condition whose lane holds the step.

branchKey
enum<string>
Available options:
yes,
no,
a,
b
conditionType
enum<string>
Available options:
invite_accepted,
clicked_link,
ab_split
splitArms
object[]

An A/B split's variants.

splitWeightsChangedAt
string<date-time>