links

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

Schedule this post onto one of your sites.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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

Name	Type	Required	What it is
`postId (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`site_id`	`string`	Yes	—
`publish_at`	`string`	Yes	—
`category`	`string`	No	—

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`post_id`	`string`	Yes	—
`post_title`	`string`	Yes	—
`site_id`	`string`	Yes	—
`site_domain`	`string`	Yes	—
`category`	`string`	Yes	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`	Yes	When the sweep may publish it — not a promise about the second.
`status`	`string<scheduled, publishing, published, failed, cancelled>`	Yes	—
`wp_post_id`	`integer`	Yes	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`	Yes	—
`target_kind`	`string<, wordpress, headless_rest, git_static>`	Yes	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`	Yes	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`	Yes	Where it lives. Empty when the destination does not report a URL.
`dropped_capabilities`	`string[][]`	Yes	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`	Yes	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`	Yes	—
`created_at`	`string`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 409 · 422

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