visibility

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

Change a watched domain's settings.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

Nazwa	Typ	Wymagane	Co to jest
`targetId (path)`	`Uuid`	Tak	The watched domain's id.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`domain`	`string`	Tak	—
`label`	`string`	Nie	—
`brand`	`string`	Nie	—
`category`	`string`	Nie	—
`market`	`string`	Nie	—
`kinds`	`VisibilityAuditKind[]`	Nie	—
`cadence_days`	`integer`	Nie	—

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`domain`	`string`	Tak	The hostname
`label`	`string`	Nie	The customer's own label for this domain.
`brand`	`string`	Nie	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`	Nie	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`	Nie	Where the business sells. Used with `category` to build the questions.
`is_external`	`boolean`	Tak	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`	Nie	The site this target corresponds to, when it is one of ours.
`kinds`	`VisibilityAuditKind[]`	Tak	—
`cadence_days`	`integer`	Tak	Days between scheduled audits. `0` means paused — not deleted. History and settings survive and it resumes with no further action.
`next_due_at`	`string`	Nie	—
`last_audit_at`	`string`	Nie	—
`review_profiles`	`ReviewProfile[]`	Nie	—
`products`	`TrackedProduct[]`	Nie	The products this organisation has asked us to price-track.
`merchant_names`	`string[]`	Nie	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[]`	Nie	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…

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}