seo-connect

POST `/v1/seo-connect/approve`

Approve a site connection for one organization.

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 field in the JSON body.

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/seo-connect/approve \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "user_code": <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

The caller must hold billing.payment.manage in org_id (or X-Zinn-Org; omitted, the one org they hold it in). Single use: a second answer from another tab is 404. Writes an audit event seo_connect.approved; the connection itself, and its audit event seo_connection.created, are written when the site exchanges its device code.

Request body

Name	Type	Required	What it is
`user_code`	`string`	Yes	—
`org_id`	`string`	No	—

Response

Name	Type	Required	What it is
`status`	`string<approved>`	Yes	—
`site_url`	`string`	Yes	—
`org`	`SeoConnectionOrg`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429