Campaigns

POST `/v1/campaigns`

Create a campaign from a template and an audience.

所有 Campaigns 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

您的组织 ID 应填在此处

此端点接受 org_id 作为 JSON 正文中的一个字段。

您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/campaigns \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "template_id": <string> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Create a campaign from a template and an audience segment. It is created as a draft and sends nothing until the send endpoint is called.

请求正文

名称	类型	必填	内容简介
`name`	`string`	是	—
`template_id`	`string`	是	—
`segment_id`	`string`	否	—
`channels`	`string<email, in_app, slack, telegram>[]`	否	—
`scheduled_for`	`string`	否	—
`include_not_in_good_standing`	`boolean`	否	⚖️ Suspended and unpaid organisations are excluded by default (CLAUDE.md §2.46); this is the explicit per-campaign override that makes a win-back campaign possible. The skip is…
`org_id`	`string`	否	—

响应

名称	类型	必填	内容简介
`id`	`string`	是	—
`org_id`	`string`	是	—
`name`	`string`	是	—
`template_id`	`string`	是	—
`segment_id`	`string`	否	—
`purpose`	`string<marketing, transactional>`	是	—
`channels`	`string[]`	是	—
`status`	`string<draft, scheduled, sending, paused, sent, cancelled, failed>`	是	—
`scheduled_for`	`string`	否	—
`include_not_in_good_standing`	`boolean`	否	—
`total_recipients`	`integer`	是	—
`skipped`	`CampaignSkipCounts`	是	⛔ Every skip counted separately and never silent, and every one is present even when it is zero. "4,127 recipients, 312 skipped — not in good standing" is rendered from thes…
`delivery`	`CampaignDeliveryCounts`	否	⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing…
`last_error`	`string`	否	—
`created_at`	`string`	是	—
`started_at`	`string`	否	—
`finished_at`	`string`	否	—

此端点可能返回的错误

401 · 403 · 422