seo-connect

POST /v1/seo-connection/edge

Purge the site's pages at the edge and set its AI-crawler rule. Free.

All seo-connect endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks sites.create; a key without it is refused with 403, not 404.

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/edge \
  -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

Called by the plugin when an SEO change makes pages stale (purge_urls, up to 30, on this site only) or changes many at once (purge_everything: server and edge cache, like the dashboard's Clear cache), and when its AI-crawler setting changes (ai_bots: block blocks AI crawlers at the edge, allow lets them through). The crawler rule is zone-wide, so it is refused on a zone shared by several sites (422), on a site our team holds back from automatic edge changes (409) and where we hold no credential for the CDN (409). A site not on Zinn® hosting is 409. Audited. Needs seo.run.

Request body

NameTypeRequiredWhat it is
purge_urlsstring[]NoPages of this site to purge at the edge (at most 30 after de-duplication).
purge_everythingbooleanNo—
ai_botsobjectNo—

Response

NameTypeRequiredWhat it is
purgeobjectYes—
ai_botsobjectYes—

Errors this endpoint can return

401 · 403 · 409 · 422 · 429 · 503