links
DELETE /v1/content/placements/{placementId}
Cancel a scheduled publication.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X DELETE https://api.zinndigital.com/v1/content/placements/{placementId} \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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ètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
placementId (path) | string | Oui | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Oui | — |
post_id | string | Oui | — |
post_title | string | Oui | — |
site_id | string | Oui | — |
site_domain | string | Oui | — |
category | string | Oui | 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_at | string | Oui | When the sweep may publish it — not a promise about the second. |
status | string<scheduled, publishing, published, failed, cancelled> | Oui | — |
wp_post_id | integer | Oui | 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_url | string | Oui | — |
target_kind | string<, wordpress, headless_rest, git_static> | Oui | 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_id | string | Oui | 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 WordPres… |
remote_post_url | string | Oui | Where it lives. Empty when the destination does not report a URL. |
dropped_capabilities | string[][] | Oui | 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… |
error | string | Oui | 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`, `m… |
published_at | string | Oui | — |
created_at | string | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 409 · 422