visibility

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

Change a watched domain's settings.

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`targetId (path)`	`Uuid`	Ya	The watched domain's id.

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`domain`	`string`	Ya	—
`label`	`string`	Tidak	—
`brand`	`string`	Tidak	—
`category`	`string`	Tidak	—
`market`	`string`	Tidak	—
`kinds`	`VisibilityAuditKind[]`	Tidak	—
`cadence_days`	`integer`	Tidak	—

Respons

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

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}