Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X POST https://api.zinndigital.com/v1/site-groups \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
Gated on sites.groups.manage in addition to sites.view. Refused with 422 when the organisation's plan does not sell site_groups, when the name is blank or already taken (case-insensitively, per organisation), or when the organisation already holds the maximum number of groups.
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
name | string | Bəli | — |
colour | string<slate, blue, green, amber, red, purple, teal, pink> | Xeyr | — |
notes | string | Xeyr | — |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | string | Bəli | — |
name | string | Bəli | 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… |
colour | string<slate, blue, green, amber, red, purple, teal, pink> | Bəli | 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… |
notes | string | Bəli | The operator's own note. Never published, never shown to anyone else. |
site_count | integer | Bəli | — |
created_at | string | Bəli | — |
updated_at | string | Bəli | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 422