links

DELETE /v1/content/placements/{placementId}

Cancel a scheduled publication.

Alle links-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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

Parameters

NaamTypeVerplichtWat dit is
placementId (path)stringJa

Reactie

NaamTypeVerplichtWat dit is
idstringJa
post_idstringJa
post_titlestringJa
site_idstringJa
site_domainstringJa
categorystringJaThe 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_atstringJaWhen the sweep may publish it — not a promise about the second.
statusstring<scheduled, publishing, published, failed, cancelled>Ja
wp_post_idintegerJaNull 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_urlstringJa
target_kindstring<, wordpress, headless_rest, git_static>JaWhich 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_idstringJaWhat 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_urlstringJaWhere it lives. Empty when the destination does not report a URL.
dropped_capabilitiesstring[][]JaWhat 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…
errorstringJaA 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_atstringJa
created_atstringJa

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 409 · 422