visibility

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

Change a watched domain's settings.

प्रमाणन

एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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 कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को 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}