OpenapiMarketing
Returns one sequence's steps in send order.
Returns one sequence's steps in send order.
GET /v1/marketing/sequences/{id}/steps
| Address | https://api.hanzo.ai/v1/marketing/sequences/{id}/steps |
| Method | GET |
| Operation | get_marketing_sequences_by_id_steps |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one sequence's steps in send order.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the sequence id from the path, as returned by create. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | StepList | ok |
200 body — 8 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | Step[] | — | Data is every step of the sequence, idx ascending — the order they send in. |
data[].body | body | string | — | Body is the message text. |
data[].createdAt | body | integer | — | CreatedAt is unix seconds, server-assigned. |
data[].delaySeconds | body | integer | — | DelaySeconds is how long after the previous step this one sends (after enrollment, for step 0). |
data[].id | body | string | — | ID is the server-assigned step id ("step_" + 128 random bits). |
data[].idx | body | integer | — | Idx is the step's 0-based position, assigned by appending: a new step always lands after the last one. |
data[].sequenceId | body | string | — | SequenceID is the sequence this step belongs to. |
data[].subject | body | string | — | Subject is the email subject line, capped at 1024 bytes. |
Failure carries the platform error shape — see Errors.
Examples
hanzo marketing sequences steps get <id>import { Configuration, MarketingApi } from 'hanzoai';
const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingSequencesByIdSteps({ id: 'id' });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).get_marketing_sequences_by_id_steps(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.MarketingAPI.GetMarketingSequencesByIdSteps(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::get_marketing_sequences_by_id_steps(&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).getMarketingSequencesByIdSteps();curl https://api.hanzo.ai/v1/marketing/sequences/<id>/steps \
-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?