API reference
links
48 endpoints in this area. Each one has its own page with its parameters, its response and a request you can run.
| Method | Path | What it does | Permission |
|---|---|---|---|
| POST | /v1/connector/claim | Redeem a pairing code — called by the Zinn® WordPress connector plugin. | No API key |
| GET | /v1/content/campaigns | Every campaign, with how far along it is. | links.view |
| POST | /v1/content/campaigns | Schedule a run of articles across a window. | links.edit |
| POST | /v1/content/campaigns/plan | Price and preview a campaign without creating it. | links.edit |
| GET | /v1/content/campaigns/{campaignId} | One campaign's queue — what is scheduled, and when each lands. | links.view |
| POST | /v1/content/campaigns/{campaignId}/cancel | Drop every article that has not started. | links.edit |
| POST | /v1/content/campaigns/{campaignId}/pause | Hold every article that has not started. | links.edit |
| POST | /v1/content/campaigns/{campaignId}/resume | Put the held articles back on the calendar. | links.edit |
| PATCH | /v1/content/campaigns/{campaignId}/runs/{runId} | Move one queued article to a different moment. | links.edit |
| GET | /v1/content/external-sites | WordPress sites you connected that we do not host. | links.view |
| POST | /v1/content/external-sites | Connect a WordPress site we do not host, with an application password. | links.edit |
| POST | /v1/content/external-sites/pairing | A one-time code for the Zinn® connector plugin. | links.edit |
| DELETE | /v1/content/external-sites/{siteId} | Remove a connected site we do not host. | links.edit |
| POST | /v1/content/external-sites/{siteId}/verify | Re-check the credential on one connected external site, now. | links.edit |
| GET | /v1/content/link-sets | Your reusable link sets — the URLs you build links to, and the words for each. | links.view |
| POST | /v1/content/link-sets | Create a link set. | links.edit |
| DELETE | /v1/content/link-sets/{linkSetId} | Delete a link set no recipe is using. | links.edit |
| GET | /v1/content/link-sets/{linkSetId} | One link set, with its resolved distribution. | links.view |
| PATCH | /v1/content/link-sets/{linkSetId} | Rename a link set, archive it, or replace its links. | links.edit |
| DELETE | /v1/content/placements/{placementId} | Cancel a scheduled publication. | links.edit |
| GET | /v1/content/posts | The organisation's content library. | links.view |
| POST | /v1/content/posts | Write a new post. | links.edit |
| POST | /v1/content/posts/generate | Write article drafts with the model. | links.edit |
| DELETE | /v1/content/posts/{postId} | Delete a post that is not live anywhere. | links.edit |
| GET | /v1/content/posts/{postId} | One post. | links.view |
| GET | /v1/content/posts/{postId}/placements | Where this post is scheduled or live. | links.view |
| POST | /v1/content/posts/{postId}/placements | Schedule this post onto one of your sites. | links.edit |
| GET | /v1/content/run-schedules | Repeating posting runs. | links.view |
| POST | /v1/content/run-schedules | Post to these sites every N hours. | links.edit |
| DELETE | /v1/content/run-schedules/{scheduleId} | Delete a cadence. | links.edit |
| PATCH | /v1/content/run-schedules/{scheduleId} | Change or pause a cadence. | links.edit |
| GET | /v1/content/runs | Multi-site AI posting runs. | links.view |
| POST | /v1/content/runs | Start a multi-site posting run. | links.edit |
| GET | /v1/content/runs/{runId} | One run, with every site's outcome. | links.view |
| POST | /v1/content/runs/{runId}/resume | Retry the sites that failed — never the ones that worked. | links.edit |
| GET | /v1/content/target-presets | The headless CMS products we can publish to, and what each can carry. | links.view |
| GET | /v1/content/targets | Which of your sites can receive a post, and why the rest cannot. | links.view |
| GET | /v1/content/targets/facets | Filter counts over the whole matching set, not the current page. | links.view |
| POST | /v1/content/targets/probe | Re-check, for real, whether these sites can receive a post. | links.edit |
| GET | /v1/link-edits | Bulk edits this organisation has run. | links.view |
| POST | /v1/link-edits | Change or remove a target's links across the network. | links.edit |
| GET | /v1/link-edits/{editId} | One bulk edit, and what happened on every site. | links.view |
| POST | /v1/link-edits/{editId}/undo | Put back exactly what a bulk edit replaced. | links.edit |
| GET | /v1/link-targets | The Link Tracker report — domains this org's sites link out to. | links.view |
| GET | /v1/link-targets/{targetId} | One target, and which of the customer's sites link to it. | links.view |
| GET | /v1/link-targets/{targetId}/edit-preview | How many links, posts and sites a bulk edit would change. | links.view |
| GET | /v1/link-targets/{targetId}/placements | Every link to this target, in every post, with its occurrence count. | links.view |
| POST | /v1/site-links/ingest | Receive one batch of a site's outbound-link scan (signed webhook). | No API key |