links
POST /v1/content/targets/probe
Re-check, for real, whether these sites can receive a post.
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/targets/probe \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "site_ids": <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
Contacts each named site's CMS and stores what came back. Gated on links.edit, because it makes outbound calls to the customer's own infrastructure. ⛔ Bounded at 100 sites per call and run 10 at a time. A refresh over a whole estate would be a self-inflicted outage; the picker refreshes what is on screen. ⛔ A site that could not be reached comes back unknown, never unsuitable, and a credential the CMS refused comes back with reason no_credential — the site is perfectly capable and we are the ones who cannot get in.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
requires (query) | string | No | The same comma-separated capability ids listContentTargets takes, so a client re-rendering rows from this response gets the same missingCapabilities it would get from a… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
site_ids | string[] | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
checked | integer | Yes | — |
items | SiteTarget[] | Yes | — |
Errors this endpoint can return
401 · 403 · 422