visibility

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

Change a watched domain's settings.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (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 कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ 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}