seo-connect

POST /v1/seo-connection/google

Start "Connect Google" — Google's consent page for this site.

All seo-connect endpoints

All developer docs →

Authentication

This endpoint does not take an API key. It takes its own credential, issued to the plugin or service that calls it, as a bearer token; see the description above.

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-connection/google \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "return_url": <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

Answers Google's consent URL for the one Zinn® Google app; the plugin opens it in a new tab. Search Console is always asked for; features adds analytics, business and indexing. Earlier grants are kept (incremental consent). Google returns the browser to completeSeoGoogle, which sends it back to return_url — an address on the connected site only — with zseo_google=connected|cancelled|scope|failed. Needs seo.run.

Request body

NameTypeRequiredWhat it is
featuresstring<search_console, analytics, business, indexing>[]No—
return_urlstringYes—

Response

NameTypeRequiredWhat it is
consent_urlstringYes—
statusstring<pending, active, needs_reconnect>Yes—

Errors this endpoint can return

401 · 403 · 422 · 429 · 503