links
POST /v1/content/campaigns/{campaignId}/pause
Hold every article that has not started.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/content/campaigns/{campaignId}/pause \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Holds every queued article. Acts only on articles that have not started — one already being written has been paid for, and one already published is on a customer's site, so pausing cannot mean un-publishing and must not appear to. affected is how many were actually held, so a screen can say "paused 8 of 12" rather than reporting a silent success the customer's own queue contradicts. Gated on links.edit.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
campaignId (path) | string | 是 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
affected | integer | 是 | How many articles the action actually touched. A campaign of twelve with four already written reports 8 for a pause, so a screen can say "paused 8 of 12" rather than a silent… |
campaign | ContentCampaign | 是 | — |
此端点可能返回的错误
401 · 403 · 404 · 422