Hanzo
OpenapiMarketing

Returns one sequence's steps in send order.

Returns one sequence's steps in send order.

GET /v1/marketing/sequences/{id}/steps

Addresshttps://api.hanzo.ai/v1/marketing/sequences/{id}/steps
MethodGET
Operationget_marketing_sequences_by_id_steps
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one sequence's steps in send order.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the sequence id from the path, as returned by create.

Response

StatusBodyMeaning
200StepListok

200 body — 8 fields.

FieldInTypeAlwaysDescription
databodyStep[]Data is every step of the sequence, idx ascending — the order they send in.
data[].bodybodystringBody is the message text.
data[].createdAtbodyintegerCreatedAt is unix seconds, server-assigned.
data[].delaySecondsbodyintegerDelaySeconds is how long after the previous step this one sends (after enrollment, for step 0).
data[].idbodystringID is the server-assigned step id ("step_" + 128 random bits).
data[].idxbodyintegerIdx is the step's 0-based position, assigned by appending: a new step always lands after the last one.
data[].sequenceIdbodystringSequenceID is the sequence this step belongs to.
data[].subjectbodystringSubject is the email subject line, capped at 1024 bytes.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing sequences steps get <id>

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page