visibility

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

Change a watched domain's settings.

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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

Параметри

Име	Тип	Задължително	Какво представлява
`targetId (path)`	`Uuid`	Да	The watched domain's id.

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`domain`	`string`	Да	—
`label`	`string`	Не	—
`brand`	`string`	Не	—
`category`	`string`	Не	—
`market`	`string`	Не	—
`kinds`	`VisibilityAuditKind[]`	Не	—
`cadence_days`	`integer`	Не	—

Отговор

Име	Тип	Задължително	Какво представлява
`id`	`Uuid`	Да	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`domain`	`string`	Да	The hostname
`label`	`string`	Не	The customer's own label for this domain.
`brand`	`string`	Не	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`	Не	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`	Не	Where the business sells. Used with `category` to build the questions.
`is_external`	`boolean`	Да	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`	Не	The site this target corresponds to, when it is one of ours.
`kinds`	`VisibilityAuditKind[]`	Да	—
`cadence_days`	`integer`	Да	Days between scheduled audits. `0` means paused — not deleted. History and settings survive and it resumes with no further action.
`next_due_at`	`string`	Не	—
`last_audit_at`	`string`	Не	—
`review_profiles`	`ReviewProfile[]`	Не	—
`products`	`TrackedProduct[]`	Не	The products this organisation has asked us to price-track.
`merchant_names`	`string[]`	Не	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[]`	Не	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…

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}