links

DELETE /v1/content/placements/{placementId}

Cancel a scheduled publication.

Tutti gli endpoint links

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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`.

Parametri

NomeTipoObbligatorioChe cos'è
placementId (path)string

Risposta

NomeTipoObbligatorioChe cos'è
idstring
post_idstring
post_titlestring
site_idstring
site_domainstring
categorystringThe 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_atstringWhen the sweep may publish it — not a promise about the second.
statusstring<scheduled, publishing, published, failed, cancelled>
wp_post_idintegerNull 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 th…
remote_post_idstringWhat 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 WordPres…
remote_post_urlstringWhere 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 nothin…
errorstringA 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`, `m…
published_atstring
created_atstring

Errori che questo endpoint può restituire

401 · 403 · 404 · 409 · 422