seo-connect

PATCH `/v1/seo-connections/{connectionId}`

Change what a connected site may do, and its monthly credit limit.

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

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-connections/{connectionId} \
  -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

Needs billing.payment.manage in the connection's organization; writes the audit event seo_connection.updated. scopes narrows (or widens back, never beyond) the four the connection was minted with and must keep seo.read: without seo.spend the site reads its results and spends nothing; without seo.run it changes nothing. A site calling an operation its scopes do not cover gets 403 with error.code = "insufficient_scope". monthly_spend_cap_micros is the most Zinn® credit the site's tools may spend per calendar month (USD micros; null removes the limit). A run on demand that would pass it is refused 403 before anything is spent; a scheduled run waits for the 1st of next month.

Parameters

Name	Type	Required	What it is
`connectionId (path)`	`Uuid`	Yes	The connection's id.

Request body

Name	Type	Required	What it is
`scopes`	`string<seo.read, seo.run, seo.spend, seo.notices>[]`	No	Must include `seo.read`.
`monthly_spend_cap_micros`	`object`	No	—

Response

Name	Type	Required	What it is
`connection_id`	`string`	Yes	—
`org_id`	`string`	Yes	—
`site_url`	`string`	Yes	—
`site_uuid`	`string`	Yes	—
`status`	`string<active, revoked>`	Yes	—
`scopes`	`string[]`	Yes	—
`method`	`string<device, signup>`	Yes	—
`token_hint`	`string`	Yes	The first eight characters after `zsc_`.
`plugin_version`	`string`	Yes	—
`created_at`	`string`	Yes	—
`last_used_at`	`object`	Yes	—
`revoked_at`	`object`	Yes	—
`revoked_by`	`object`	Yes	—
`target_id`	`object`	Yes	The site's own watch-list row (`getSeoSiteTarget`), once it has one.
`monthly_spend_cap_micros`	`object`	Yes	The most Zinn® credit this site's tools may spend per calendar month, USD micros; `null` is no limit. Set with `updateOrgSeoConnection`.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429

PATCH /v1/seo-connections/{connectionId}