Hanzo
OpenapiMarketing

Stops one walk mid-sequence and answers 204: no further step is sent, and steps…

Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.

POST /v1/marketing/sequences/{id}/enrollments/{eid}/cancel

Addresshttps://api.hanzo.ai/v1/marketing/sequences/{id}/enrollments/{eid}/cancel
MethodPOST
Operationpost_marketing_sequences_by_id_enrollments_by_eid_cancel
AuthAuthorization: Bearer $HANZO_API_KEY

Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found.

Request

2 fields.

FieldInTypeRequiredDescription
idpathstringyesID is the sequence id from the path.
eidpathstringyesEID is the enrollment id from the path, as returned by a single-address enroll.

Response

StatusBodyMeaning
204no content

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing sequences enrollments cancel <id> <eid>

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page