seo-connect

PATCH /v1/seo-connection/google

Choose the Search Console property, GA4 property and Business Profile location.

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 PATCH https://api.zinndigital.com/v1/seo-connection/google \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Each choice is checked against what Google says the connected account can see, and a Search Console or GA4 property must cover this site's address. An empty string clears a choice; an absent field is left as it is. Audited (seo_google.updated). Needs seo.run.

Request body

NameTypeRequiredWhat it is
search_console_propertyobjectNo—
analytics_propertyobjectNo—
business_locationobjectNo—

Response

NameTypeRequiredWhat it is
connectedbooleanYes—
statusstring<none, pending, active, needs_reconnect>Yes—
account_emailstringYes—
featuresstring<search_console, analytics, business, indexing>[]Yes—
search_console_propertystringYes—
analytics_propertystringYes—
business_locationstringYes—
redirect_uristringYesWhere Google returns the browser (shown for support).
choicesobjectNoOnly with choices=1.

Errors this endpoint can return

401 · 403 · 404 · 409 · 422 · 429 · 503