visibility

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

Change a watched domain's settings.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`targetId (path)`	`Uuid`	Ano	The watched domain's id.

Tělo požadavku

Název	Typ	Požadováno	Co to je
`domain`	`string`	Ano	—
`label`	`string`	Ne	—
`brand`	`string`	Ne	—
`category`	`string`	Ne	—
`market`	`string`	Ne	—
`kinds`	`VisibilityAuditKind[]`	Ne	—
`cadence_days`	`integer`	Ne	—

Odpověď

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

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}