links

DELETE /v1/content/placements/{placementId}

Cancel a scheduled publication.

Всички крайни точки в links

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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

Параметри

ИмеТипЗадължителноКакво представлява
placementId (path)stringДа

Отговор

ИмеТипЗадължителноКакво представлява
idstringДа
post_idstringДа
post_titlestringДа
site_idstringДа
site_domainstringДа
categorystringДа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_atstringДаWhen the sweep may publish it — not a promise about the second.
statusstring<scheduled, publishing, published, failed, cancelled>Да
wp_post_idintegerДа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_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_idstringДа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_urlstringДаWhere 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…
errorstringДа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_atstringДа
created_atstringДа

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 409 · 422