links

POST `/v1/connector/claim`

Redeem a pairing code — called by the Zinn® WordPress connector plugin.

Authentication

This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.

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/connector/claim \
  -H "Content-Type: application/json" \
  -d '{ "code": <string>, "site_url": <string>, "username": <string>, "application_password": <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

**Unauthenticated by necessity**: the caller is a WordPress plugin on the customer's own server, which has no session with us. The pairing code identifies the organisation, is single-use, and expires in thirty minutes. The credential it carries is verified against the site before anything is stored. Every invalid-code failure returns the same sentence, so a caller cannot use this endpoint to discover whether a code exists.

Request body

Name	Type	Required	What it is
`code`	`string`	Yes	—
`site_url`	`string`	Yes	—
`username`	`string`	Yes	—
`application_password`	`string`	Yes	—
`site_name`	`string`	No	—

Response

Name	Type	Required	What it is
`site_id`	`string`	Yes	—
`primary_domain`	`string`	Yes	—
`detail`	`string`	Yes	—

Errors this endpoint can return

422 · 429

POST /v1/connector/claim