seo-connect
PATCH /v1/seo-connection/products/watches/{watchId}
Change, pause or restart a scheduled credit tool.
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 PATCH https://api.zinndigital.com/v1/seo-connection/products/watches/{watchId} \
-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
Changing the parameters or switching it back on needs seo.spend; switching it on makes it due at the next hourly sweep.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
watchId (path) | Uuid | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
params | SeoProductParams | No | The tool's parameters. geo_grid: phrase, lat, lng, size (3/5/7/9), spacing_km (0.2-10), business (Google id or name), domain, language — billed size x size… |
cadence_days | integer<1, 7, 30> | No | — |
active | boolean | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
product | SeoProductCode | Yes | geo_grid local rank grid (zs-520) · reviews Google/Trustpilot/Tripadvisor reviews (zs-521) · shopping Google Shopping price and position (zs-522) · traffic competitor… |
params | SeoProductParams | Yes | The tool's parameters. geo_grid: phrase, lat, lng, size (3/5/7/9), spacing_km (0.2-10), business (Google id or name), domain, language — billed size x size… |
cadence_days | integer | Yes | — |
active | boolean | Yes | — |
next_due_at | object | Yes | — |
last_attempted_at | object | Yes | — |
last_run_id | object | Yes | — |
held_since | object | Yes | Paused for want of credit since then; carries on by itself after a top-up. |
last_skip | string | Yes | Why the last scheduled run did not happen (insufficient_credit, spend_cap …). |
cost_per_run_micros | integer | Yes | — |
cost_30d_micros | integer | Yes | — |
currency | string<USD> | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422