Open Web UIInstall

Summary

Update a group's details by its unique identifier using a POST request to the /api/v1/groups/id/{id}/update endpoint.

Inputs

• Id (required) — The unique identifier of the group to update (path parameter).
• Name (required) — The new name for the group (request body).
• Description (required) — The new description for the group (request body).
• Permissions — Updated permissions for the group, provided as a stringified JSON or object (request body).
• User Ids — Array of user IDs to associate with the group (request body).
• Skip Authentication — If set to true, the authentication step is skipped for this request.

Output shape

a single updated group record as JSON object

Returns the updated group object in JSON following the request. The operation requires authentication unless 'Skip Authentication' is set to true.

Examples

Example 1: Update group with ID '123' to change its name and description, optionally adjusting permissions and user associations.

Set 'Id' path parameter to '123'. Provide 'Name' and 'Description' with desired values. Optionally set 'Permissions' and 'User Ids' in the request body. Ensure authentication is enabled unless deliberately skipped.

Links

• n8n community nodes installation guide