hosting

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

Rename or recolour a site group.

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`groupId (path)`	`string`	Evet	—

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`name`	`string`	Hayır	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	Hayır	—
`notes`	`string`	Hayır	—

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`string`	Evet	—
`name`	`string`	Evet	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>`	Evet	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`	Evet	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Evet	—
`created_at`	`string`	Evet	—
`updated_at`	`string`	Evet	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422

PATCH /v1/site-groups/{groupId}