Hanzo
OpenapiMarketing

Adds one contact or a whole audience to a sequence and schedules the first step…

Adds one contact or a whole audience to a sequence and schedules the first step for each.

POST /v1/marketing/sequences/{id}/enroll

Addresshttps://api.hanzo.ai/v1/marketing/sequences/{id}/enroll
MethodPOST
Operationpost_marketing_sequences_by_id_enroll
AuthAuthorization: Bearer $HANZO_API_KEY

Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId.

Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send.

Request

5 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the sequence id from the path.
addressbodystringAddress is a single recipient, normalized (lower-cased, trimmed) before use.
audienceIdbodystringAudienceID fans the sequence out over a saved audience, resolved live to the org's mailable customers.
channelbodystringChannel is the delivery surface; empty means email.
idbodystringID is the sequence id from the path.

Response

StatusBodyMeaning
200EnrollResultok

200 body — 4 fields.

FieldInTypeAlwaysDescription
alreadyEnrolledbodyintegerAlreadyEnrolled is how many this sequence had already taken and were left alone.
enrolledbodyintegerEnrolled is how many started a walk on this call.
enrollmentIdbodystringEnrollmentID names the walk, and is present ONLY for a single-address enroll — a fan-out has many, and reporting one of them would be a lie.
resolvedbodyintegerResolved is how many addresses the request named — 1 for an address, the audience's deliverable count for an audience.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing sequences enroll <id>

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page