hosting

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

Rename or recolour a site group.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`groupId (path)`	`string`	Ano	—

Tělo požadavku

Název	Typ	Požadováno	Co to je
`name`	`string`	Ne	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	Ne	—
`notes`	`string`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`string`	Ano	—
`name`	`string`	Ano	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>`	Ano	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`	Ano	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Ano	—
`created_at`	`string`	Ano	—
`updated_at`	`string`	Ano	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422

PATCH /v1/site-groups/{groupId}