Skip to main content
POST
Preview 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]+$

Response

The step as one person would get it. Nothing is saved or sent.

stepId
string
required
subject
string
body
string
channel
string
type
string
person
object

The person it was written for.