visibility

PUT `/v1/visibility/targets/{targetId}/local`

Save the business, the towns and the keywords.

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 PUT https://api.zinndigital.com/v1/visibility/targets/{targetId}/local \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "places": <LocalPlace[]>, "keywords": <LocalKeyword[]> }'

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

Replaces the towns and keywords wholesale; every keyword is checked from every town. Refused with 422 naming the allowance when it would exceed the towns per business, the keyword rows or the checks a month the plan sells (planned as daily 30, weekly 4.3, monthly 1 check a month), or when a keyword asks for a faster schedule than the plan includes. It is never truncated. A keyword with no frequency runs at the plan's own cadence. Changing the business clears the previous business's history.

Parameters

Name	Type	Required	What it is
`targetId (path)`	`Uuid`	Yes	The watched domain's id.

Request body

Name	Type	Required	What it is
`business`	`LocalBusiness`	No	—
`places`	`LocalPlace[]`	Yes	—
`keywords`	`LocalKeyword[]`	Yes	—

Response

Name	Type	Required	What it is
`target_id`	`string`	Yes	—
`domain`	`string`	Yes	—
`label`	`string`	Yes	—
`business`	`LocalBusiness \| null`	Yes	—
`places`	`LocalPlace[]`	Yes	—
`keywords`	`LocalKeyword[]`	Yes	—
`rows`	`LocalRow[]`	Yes	—
`last_checked_at`	`object`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422

PUT /v1/visibility/targets/{targetId}/local