seo-connect

DELETE /v1/seo-connections/{connectionId}

Disconnect a site from the app.

All seo-connect endpoints

All developer docs →

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.

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 DELETE https://api.zinndigital.com/v1/seo-connections/{connectionId} \
  -H "Authorization: Bearer zdk_live_…"

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

Needs billing.payment.manage in the connection's organization. Idempotent; the first revoke writes an audit event. The site's token is then 401 connection_revoked.

Parameters

NameTypeRequiredWhat it is
connectionId (path)UuidYesThe connection's id.

Response

NameTypeRequiredWhat it is
connection_idstringYes—
org_idstringYes—
site_urlstringYes—
site_uuidstringYes—
statusstring<active, revoked>Yes—
scopesstring[]Yes—
methodstring<device, signup>Yes—
token_hintstringYesThe first eight characters after zsc_.
plugin_versionstringYes—
created_atstringYes—
last_used_atobjectYes—
revoked_atobjectYes—
revoked_byobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 429