visibility

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

Change a watched domain's settings.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua 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> }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`targetId (path)`	`Uuid`	Sì	The watched domain's id.

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`domain`	`string`	Sì	—
`label`	`string`	No	—
`brand`	`string`	No	—
`category`	`string`	No	—
`market`	`string`	No	—
`kinds`	`VisibilityAuditKind[]`	No	—
`cadence_days`	`integer`	No	—

Risposta

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

Errori che questo endpoint può restituire

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}