seo-connect

POST `/v1/seo-connect/start`

Start connecting a Zinn® SEO site to a Zinn® account (device code).

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/seo-connect/start \
  -H "Content-Type: application/json" \
  -d '{ "site_url": <string>, "site_uuid": <string>, "consent": <boolean<True>> }'

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

Called server-side by the Zinn® SEO WordPress plugin after the site owner agreed on its opt-in screen (WordPress.org guideline 7). Returns a secret device_code the site keeps and a short user_code (BCDF-GHJK) with the page the plugin opens in a NEW TAB, where a signed-in member approves the site for one organization (approveSeoConnect). The site then polls exchangeSeoConnect. Requests last ten minutes. No password ever enters wp-admin. ADR 0038. Anonymous, server-to-server (no CORS). Budget: 120/hour per IP, sized for shared hosting where many sites share one address; 429 with Retry-After.

Request body

Name	Type	Required	What it is
`site_url`	`string`	Yes	—
`site_uuid`	`string`	Yes	The plugin's own install id, kept in an option; a reconnect replaces the old token.
`plugin_version`	`string`	No	—
`wp_version`	`string`	No	—
`locale`	`string`	No	The WordPress locale (`fr_FR`).
`consent`	`boolean<True>`	Yes	Literally `true` — the site owner agreed on the plugin's opt-in screen.

Response

Name	Type	Required	What it is
`device_code`	`string`	Yes	Secret. Keep it on the server; never show it.
`user_code`	`string`	Yes	—
`verification_uri`	`string`	Yes	—
`verification_uri_complete`	`string`	Yes	Open this in a NEW TAB — the code is filled in.
`expires_in`	`integer`	Yes	Seconds.
`interval`	`integer`	Yes	Seconds between polls of `exchangeSeoConnect`.

Errors this endpoint can return

422 · 429

POST /v1/seo-connect/start