Campaigns

POST /v1/campaigns/{campaignId}/send

Start the durable send.

所有 Campaigns 端点

身份验证

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

您的组织 ID 应填在此处

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

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

免费试用

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

curl -X POST https://api.zinndigital.com/v1/campaigns/{campaignId}/send \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

详细信息

Returns immediately; the send runs as a Temporal workflow that resumes rather than truncating. A send above the confirmation threshold requires `confirm` to equal the campaign's name exactly — enforced here, because a control that lives only in the client is one an API call walks past.

参数

名称类型必填内容简介
campaignId (path)string

请求正文

名称类型必填内容简介
confirmstring
org_idstring

响应

名称类型必填内容简介
idstring
org_idstring
namestring
template_idstring
segment_idstring
purposestring<marketing, transactional>
channelsstring[]
statusstring<draft, scheduled, sending, paused, sent, cancelled, failed>
scheduled_forstring
include_not_in_good_standingboolean
total_recipientsinteger
skippedCampaignSkipCounts⛔ 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…
deliveryCampaignDeliveryCounts⛔ `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_errorstring
created_atstring
started_atstring
finished_atstring

此端点可能返回的错误

401 · 403 · 404 · 409 · 422