hosting

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

Rename or recolour a site group.

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`groupId (path)`	`string`	Sí	—

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`name`	`string`	No	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	No	—
`notes`	`string`	No	—

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`id`	`string`	Sí	—
`name`	`string`	Sí	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>`	Sí	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`	Sí	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Sí	—
`created_at`	`string`	Sí	—
`updated_at`	`string`	Sí	—

Errores que este endpoint puede devolver

401 · 403 · 404 · 422

PATCH /v1/site-groups/{groupId}