links

DELETE /v1/content/placements/{placementId}

Cancel a scheduled publication.

Todos os endpoints de links

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

NomeTipoObrigatórioO que é
placementId (path)stringSim

Resposta

NomeTipoObrigatórioO que é
idstringSim
post_idstringSim
post_titlestringSim
site_idstringSim
site_domainstringSim
categorystringSimThe 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_atstringSimWhen the sweep may publish it — not a promise about the second.
statusstring<scheduled, publishing, published, failed, cancelled>Sim
wp_post_idintegerSimNull 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_urlstringSim
target_kindstring<, wordpress, headless_rest, git_static>SimWhich 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_idstringSimWhat 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_urlstringSimWhere it lives. Empty when the destination does not report a URL.
dropped_capabilitiesstring[][]SimWhat 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…
errorstringSimA 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_atstringSim
created_atstringSim

Erros que este endpoint pode retornar

401 · 403 · 404 · 409 · 422