links

POST /v1/content/external-sites/pairing

A one-time code for the Zinn® connector plugin.

All links endpoints

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.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

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/external-sites/pairing \
  -H "Authorization: Bearer zdk_live_…"

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

Gated on `links.edit`. Install the Zinn® connector plugin on the WordPress site and paste this code into it; the plugin creates its own application password and connects the site, so nothing is copied by hand. The code is single-use and expires in thirty minutes.

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNo

Response

NameTypeRequiredWhat it is
codestringYes
expires_atstringYes
plugin_slugstringYes

Errors this endpoint can return

401 · 403