links

POST /v1/content/posts/{postId}/placements

Schedule this post onto one of your sites.

All links endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the links.edit permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/content/posts/{postId}/placements \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "site_id": <string>, "publish_at": <string> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Publishes the post to that site, in that WordPress category, at that time — V1's PostTask. The category is a name, not a term id, because a term id is per-site and one post goes to many sites. Refused with 409 if the post is already scheduled or live on that site: publishing the same content twice to one site is a duplicate-content footprint on the line whose premise is not leaving one. Gated on links.edit.

Parameters

NameTypeRequiredWhat it is
postId (path)stringYes—

Request body

NameTypeRequiredWhat it is
site_idstringYes—
publish_atstringYes—
categorystringNo—

Response

NameTypeRequiredWhat it is
idstringYes—
post_idstringYes—
post_titlestringYes—
site_idstringYes—
site_domainstringYes—
categorystringYesThe 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_atstringYesWhen the sweep may publish it — not a promise about the second.
statusstring<scheduled, publishing, published, failed, cancelled>Yes—
wp_post_idintegerYesNull 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_urlstringYes—
target_kindstring<, wordpress, headless_rest, git_static>YesWhich 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_idstringYesWhat 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_urlstringYesWhere it lives. Empty when the destination does not report a URL.
dropped_capabilitiesstring[][]YesWhat 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…
errorstringYesA 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_atstringYes—
created_atstringYes—

Errors this endpoint can return

401 · 403 · 404 · 409 · 422