Skip to main content
PATCH
Update a step

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]+$
stepId
string
required

The step's id, from GET /v1/campaigns/{campaignId}/steps.

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

Body

application/json
subject
string

A manual step's new subject line, sent with body: the two replace the step's whole message.

Maximum string length: 500
body
string

A manual step's new message, sent with subject. On a linkedin_connection step, the invitation note, up to 200 characters.

Maximum string length: 50000
topic
string

What an AI step should say. Its title is written again from it.

Maximum string length: 1000
daysBetween
integer

Days to wait after the step before, 0 to 365. On a condition, its window, 1 to 30, and the only field it takes.

Required range: 0 <= x <= 365
splitArms
object[]

An A/B split's variants, its only field: both, a then b, with weights adding up to 100. Leads not yet written to follow the new weights.

Required array length: 2 elements

Response

The step's id. Read the step with GET /v1/campaigns/{campaignId}/steps.

id
string
required