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
| Address | https://api.hanzo.ai/v1/marketing/sequences/{id}/enrollments/{eid}/cancel |
| Method | POST |
| Operation | post_marketing_sequences_by_id_enrollments_by_eid_cancel |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the sequence id from the path. |
eid | path | string | yes | EID is the enrollment id from the path, as returned by a single-address enroll. |
Response
| Status | Body | Meaning |
|---|---|---|
204 | — | no content |
Failure carries the platform error shape — see Errors.
Examples
hanzo marketing sequences enrollments cancel <id> <eid>import { Configuration, MarketingApi } from 'hanzoai';
const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postMarketingSequencesByIdEnrollmentsByEidCancel({ id: 'id', eid: 'eid' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).post_marketing_sequences_by_id_enrollments_by_eid_cancel(id='id', eid='eid')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.MarketingAPI.PostMarketingSequencesByIdEnrollmentsByEidCancel(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, marketing_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = marketing_api::post_marketing_sequences_by_id_enrollments_by_eid_cancel(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new MarketingApi(client).postMarketingSequencesByIdEnrollmentsByEidCancel();curl -X POST https://api.hanzo.ai/v1/marketing/sequences/<id>/enrollments/<eid>/cancel \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches marketing through the marketing tool, which names its 35 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_marketing_audiences"
}
}
}'How is this guide?