Update a group
What it does
Section titled “What it does”Updates a group’s display name, technical name, and/or parent. Use parentId to move the group under another parent, or set parentId to null to make it a top-level group.
Request
Section titled “Request”PATCH /api/v1/groups/{id}
| Auth | Required |
| Query parameters | None |
Path parameters
Section titled “Path parameters”| Name | Type | Description |
|---|---|---|
id | string | Group id |
Headers
Section titled “Headers”Authorization: Bearer <your-api-key>Content-Type: application/jsonAll fields optional:
{ "displayName": "Site footer", "technicalName": "footer", "parentId": null}| Field | Type | Description |
|---|---|---|
displayName | string | null | New display name |
technicalName | string | null | New technical name |
parentId | string | null | New parent id, or null for root |
Example
Section titled “Example”curl -sS -X PATCH https://collingo.app/api/v1/groups/clgroupaaaaaaaaaaaaaaaaaa \ -H "Authorization: Bearer <your-api-key>" \ -H "Content-Type: application/json" \ -d '{"displayName": "Site footer"}'Response
Section titled “Response”200 OK
Section titled “200 OK”Returns the updated Group object (same shape as Get a group).
Errors
Section titled “Errors”| Status | When |
|---|---|
400 | Validation failed |
401 | Missing or invalid API key (ERR_UNAUTHORIZED) |
403 | Insufficient role (ERR_FORBIDDEN) |
404 | Group not found |
409 | Conflict (for example duplicate technical name or invalid parent) |
500 | Database or internal error |