links

DELETE /v1/content/placements/{placementId}

Cancel a scheduled publication.

Minden links végpont

Az összes fejlesztői dokumentáció

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

NévTípusKötelezőMi ez
placementId (path)stringIgen

Válasz

NévTípusKötelezőMi ez
idstringIgen
post_idstringIgen
post_titlestringIgen
site_idstringIgen
site_domainstringIgen
categorystringIgenThe 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_atstringIgenWhen the sweep may publish it — not a promise about the second.
statusstring<scheduled, publishing, published, failed, cancelled>Igen
wp_post_idintegerIgenNull 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_urlstringIgen
target_kindstring<, wordpress, headless_rest, git_static>IgenWhich 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_idstringIgenWhat 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_urlstringIgenWhere it lives. Empty when the destination does not report a URL.
dropped_capabilitiesstring[][]IgenWhat 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…
errorstringIgenA 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_atstringIgen
created_atstringIgen

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 409 · 422