links

DELETE /v1/content/placements/{placementId}

Cancel a scheduled publication.

همه نقاط پایانی links

همهٔ مستندات توسعه‌دهندگان

احراز هویت

یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمی‌کند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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 the…
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 WordPress…
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 nothing…
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,…
published_atstringبله
created_atstringبله

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 409 · 422