Skip to main content
POST
Add campaign step

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string<uuid>
required

Campaign ID.

Body

application/json
type
enum<string>
required

Step type. Email steps are sent automatically; the others create tasks.

Available options:
email,
manual,
text,
linkedin_message,
linkedin_connection,
call
send_after_days
integer
required

Days to wait after the previous step (or after enrollment, for the first step).

Required range: 0 <= x <= 365
subject
string | null

Email subject, or the InMail subject for LinkedIn message steps. Only the first email step has its own subject: later email steps always use "Re: " so they land in the same thread (a "Re:" on the first email is removed). Editing a later email's subject is rejected. Can use {{variables}}.

Maximum string length: 998
body_html
string

Step body as HTML (paragraphs, headings, line breaks, bold, italic, underline, strikethrough, highlight, links, lists and images). Each

is followed by an empty line, as in the campaign builder; use
for a line break without a gap. Images need a public https URL and are shown as their own block. Can use {{variables}}, including inside link URLs. For non-email steps this is the task or message text; LinkedIn connection notes are limited to 300 characters.

Maximum string length: 100000
timezone
string | null

IANA timezone for the sending window, for example Europe/London. Defaults to the timezone of the campaign owner's first connected mailbox. Without one, the step sends in New York business hours (America/New_York).

time_window_start
string | null

Start of the sending window for email steps, in 24-hour HH:MM. Left empty, the step sends between 09:00 and 17:00 in its timezone.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
time_window_end
string | null

End of the sending window for email steps, in 24-hour HH:MM. Must differ from time_window_start.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
include_signature
boolean

Add the sender's email signature to this email step.

block_until_task_complete
boolean

For task steps (not emails): hold the rest of the campaign until this task is marked complete. Turning it off releases anyone already waiting on the step.

ai_variables
object[]

A description for every {{ai:name}} used in this step. Descriptions for names not used in the step are ignored.

Maximum array length: 20

Response

Step added

success
enum<boolean>
required
Available options:
true
data
object
required