seo-connect
PUT /v1/seo-connection/reports
Set up or change this site's client and its report schedule.
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 PUT https://api.zinndigital.com/v1/seo-connection/reports \
-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
Zinn® SEO stage P12. The client's one domain is always the site's own host (a site never reports on another). Same rules and caps as createClientReportClient; refused past the plan's clients (refusal.clientReports.notHeld without Client Reports). Needs seo.run.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | No | — |
recipients | string[] | No | — |
locale | string | No | — |
sections | ClientReportSectionKey[] | No | — |
contact_name | string | No | — |
cadence | ClientReportCadence | No | — |
send_email | boolean | No | — |
narrative | boolean | No | — |
active | boolean | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site | string | Yes | The site's bare host — the only domain its report names. |
client | ClientReportClient | null | Yes | — |
brand | ClientReportBrand | null | Yes | — |
allowance | ClientReportAllowance | Yes | — |
sections | ClientReportSectionKey[] | Yes | — |
sections_with_data | ClientReportSectionKey[] | Yes | — |
reports | ClientReport[] | Yes | — |
sinks | ClientReportSink[] | Yes | — |
portal_links | ClientPortalLink[] | Yes | — |
app_reports_url | string | Yes | The app's Reports screen (every client). |
app_agency_url | string | Yes | zs-422: the agency overview of every connected site in the app. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429