hosting

PATCH `/v1/site-groups/{groupId}`

Rename or recolour a site group.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

Parametri

Naziv	Vrsta	Obavezno	Što je to
`groupId (path)`	`string`	Da	—

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`name`	`string`	Ne	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	Ne	—
`notes`	`string`	Ne	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`id`	`string`	Da	—
`name`	`string`	Da	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>`	Da	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 ren…
`notes`	`string`	Da	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Da	—
`created_at`	`string`	Da	—
`updated_at`	`string`	Da	—

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422

PATCH /v1/site-groups/{groupId}