प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।

यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

curl -X PATCH https://api.zinndigital.com/v1/site-groups/{groupId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्

विवरणहरू

Fields omitted from the body are left alone. Gated on sites.groups.manage.

प्यारामिटरहरू

नामप्रकारआवश्यकयो के हो
groupId (path)stringहुन्छ

अनुरोध बडी

नामप्रकारआवश्यकयो के हो
namestringहैन
colourstring<slate, blue, green, amber, red, purple, teal, pink>हैन
notesstringहैन

प्रतिक्रिया

नामप्रकारआवश्यकयो के हो
idstringहुन्छ
namestringहुन्छUnique per organisation, case-insensitively. Two groups called Casino and CASINO are a support ticket rather than a feature — nobody can tell them apart in a filter and half…
colourstring<slate, blue, green, amber, red, purple, teal, pink>हुन्छA chip colour from a closed set, never a free hex value. The dashboard draws these through the design system's contrast-checked tone tokens; a customer-supplied colour would…
notesstringहुन्छThe operator's own note. Never published, never shown to anyone else.
site_countintegerहुन्छ
created_atstringहुन्छ
updated_atstringहुन्छ

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 404 · 422