visibility

PATCH `/v1/visibility/targets/{targetId}`

Change a watched domain's settings.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

curl -X PATCH https://api.zinndigital.com/v1/visibility/targets/{targetId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "domain": <string> }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

Updates the label, brand, category, market, cadence or which products watch this domain. `cadence_days: 0` pauses rather than deletes.

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`targetId (path)`	`Uuid`	Oo	The watched domain's id.

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`domain`	`string`	Oo	—
`label`	`string`	Hindi	—
`brand`	`string`	Hindi	—
`category`	`string`	Hindi	—
`market`	`string`	Hindi	—
`kinds`	`VisibilityAuditKind[]`	Hindi	—
`cadence_days`	`integer`	Hindi	—

Tugon

Pangalan	Uri	Kailangan	Ano ito
`id`	`Uuid`	Oo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`domain`	`string`	Oo	The hostname
`label`	`string`	Hindi	The customer's own label for this domain.
`brand`	`string`	Hindi	The trading name to look for in an answer engine's reply. Genuinely separate from the domain — an answer that recommends a business by name without printing its URL has still me…
`category`	`string`	Hindi	What this business sells, in the customer's own words. The questions asked of the answer engines are built from it, so it is the single field that decides whether an AI-visibili…
`market`	`string`	Hindi	Where the business sells. Used with `category` to build the questions.
`is_external`	`boolean`	Oo	True when this is not a domain hosted with us — a competitor or a prospect. Only external targets count against the plan's allowance.
`site_id`	`string`	Hindi	The site this target corresponds to, when it is one of ours.
`kinds`	`VisibilityAuditKind[]`	Oo	—
`cadence_days`	`integer`	Oo	Days between scheduled audits. `0` means paused — not deleted. History and settings survive and it resumes with no further action.
`next_due_at`	`string`	Hindi	—
`last_audit_at`	`string`	Hindi	—
`review_profiles`	`ReviewProfile[]`	Hindi	—
`products`	`TrackedProduct[]`	Hindi	The products this organisation has asked us to price-track.
`merchant_names`	`string[]`	Hindi	How this business appears as a seller on the marketplaces. Confirmed by the customer and never inferred: Google Shopping publishes a seller name and no domain on its listing…
`keywords`	`TrackedKeyword[]`	Hindi	The search phrases this organisation tracks its position for. Customer-supplied and never derived: asking a vendor which phrases a domain already ranks for would return exactly…

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}