hosting

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

Rename or recolour a site group.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`groupId (path)`	`string`	Sim	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`name`	`string`	Não	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	Não	—
`notes`	`string`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	—
`name`	`string`	Sim	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>`	Sim	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`	Sim	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Sim	—
`created_at`	`string`	Sim	—
`updated_at`	`string`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

PATCH /v1/site-groups/{groupId}