links
POST /v1/content/campaigns
Schedule a run of articles across a window.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/content/campaigns \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "brief": <string>, "posts": <integer> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Creates one queued article per topic, each targeting every site the campaign resolved to, each with its own moment inside the drip window. Gated on links.edit. Nothing is started by this call. The articles are queued as pending runs and a Temporal sweep starts each when its moment arrives — so the request path carries no long work, generation cost is spread across the window rather than paid upfront, and a campaign created during a Temporal outage is visible and simply starts late. Refused with 422 when the account is not in good standing: we do not spend money on an account that is not being paid for.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | string | いいえ | Narrow to one organisation. A reseller managing several client organisations reads the wrong one without it — and on a footprint-free network, another operator's posting schedule… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
brief | string | はい | The standing instruction — voice, audience, what the sites are about. |
posts | integer | はい | How many ARTICLES to write. Each is placed on every target site, so the number of publications is this times the site count. |
topics | string[] | いいえ | One subject per article, so N articles are N articles rather than N paraphrases. A shorter list cycles; an empty one means the brief alone. |
site_ids | string[] | いいえ | — |
site_group_id | string | いいえ | A site group, resolved when the campaign is created rather than copied. A recurring schedule pointed at a group re-resolves it on every firing, so sites added later are… |
drip_days | integer | いいえ | Spread the articles across this many days. 0 publishes them together. |
drip_jitter_minutes | integer | いいえ | Randomise each moment by up to this many minutes either way. Perfectly even spacing is more detectable than posting all at once — nothing a person does is that regular — so this… |
anchors | ContentRunAnchor[] | いいえ | — |
category | string | いいえ | — |
publish_policy | ContentRunPublishPolicy | いいえ | How far a run may go on its own. draft_only is the default and puts nothing live. |
recipe_id | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
campaign_id | string | はい | — |
targets | ContentCampaignTargets | はい | — |
posts | ContentCampaignPlannedPost[] | はい | — |
total_articles | integer | はい | Articles written. One per topic. |
total_placements | integer | はい | Individual publications — articles times sites. The number that reads as "how much am I about to do", and the one the spend estimate is built on. |
first_at | string | いいえ | — |
last_at | string | いいえ | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422