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

التفاصيل

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…

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}