links

DELETE /v1/content/placements/{placementId}

Cancel a scheduled publication.

すべての links エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X DELETE https://api.zinndigital.com/v1/content/placements/{placementId} \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Refused with 422 once the post is published — cancelling a schedule does not take a live page down, and answering 200 would leave the customer believing it had. Gated on links.edit.

パラメータ

名前タイプ必須これがその内容です
placementId (path)stringはい

返信

名前タイプ必須これがその内容です
idstringはい
post_idstringはい
post_titlestringはい
site_idstringはい
site_domainstringはい
categorystringはいThe WordPress category NAME. Empty means the site's default category. A name rather than a term id because term ids are per-site and one post goes to many.
publish_atstringはいWhen the sweep may publish it — not a promise about the second.
statusstring<scheduled, publishing, published, failed, cancelled>はい
wp_post_idintegerはいNull until the post is live. Nullable rather than 0, because "not published yet" and "published as post 0" are different facts and a zero renders as a broken link.
wp_post_urlstringはい
target_kindstring<, wordpress, headless_rest, git_static>はいWhich adapter published it. Empty until it publishes. A placement is no longer necessarily a WordPress post — wp_post_id/wp_post_url above are the WordPress projection of the…
remote_post_idstringはいWhat the destination calls the thing it created. A string, because a Ghost id is a hex ObjectId, a Shopify id is a GID URL and a Git target's is a commit sha — only WordPress…
remote_post_urlstringはいWhere it lives. Empty when the destination does not report a URL.
dropped_capabilitiesstring[][]はいWhat the destination could not carry, and why — [["featured_image", "this destination has nowhere to attach a featured image"], …]. ⛔ Empty is the normal case and means nothing…
errorstringはいA machine code the client localises, never a sentence. One of site_not_active, site_changed_owner, no_adapter, no_target_configured, no_credential, no_repository,…
published_atstringはい
created_atstringはい

このエンドポイントが返すエラー

401 · 403 · 404 · 409 · 422