links

DELETE /v1/content/placements/{placementId}

Cancel a scheduled publication.

Všechny koncové body links

Všechny dokumenty pro vývojáře

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

NázevTypPožadovánoCo to je
placementId (path)stringAno

Odpověď

NázevTypPožadovánoCo to je
idstringAno
post_idstringAno
post_titlestringAno
site_idstringAno
site_domainstringAno
categorystringAnoThe 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_atstringAnoWhen the sweep may publish it — not a promise about the second.
statusstring<scheduled, publishing, published, failed, cancelled>Ano
wp_post_idintegerAnoNull 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_urlstringAno
target_kindstring<, wordpress, headless_rest, git_static>AnoWhich 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_idstringAnoWhat 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_urlstringAnoWhere it lives. Empty when the destination does not report a URL.
dropped_capabilitiesstring[][]AnoWhat 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…
errorstringAnoA 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_atstringAno
created_atstringAno

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 409 · 422