Update Group

PATCH

/groups/1

Update an existing group by ID.

Authentication

Required Scope: groups:write

Path Parameters

Parameter	Type	Description
`id`	integer	Required. The group ID to update

Request Body

Field	Type	Required	Validation	Description
`name`	string	Yes	max:255, unique per tenant (excludes current group)	Group name

Response

Success (200 OK): Returns the freshly-loaded group object. Includes message: "Group updated successfully".

Error Responses

Status	Code	Description
404	`NOT_FOUND`	Group not found
422	`VALIDATION_ERROR`	Validation failed
500	`INTERNAL_ERROR`	Failed to update group

Validation Error Messages

Field	Message
`name`	Group name is required / A group with this name already exists

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢200

application/json

Successful response

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/groups/1' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Premium VIP Customers"
}'

Response Example

{}

Modified at 2026-02-25 01:06:20

Get Group

Delete Group

Update Group

Authentication#

Path Parameters#

Request Body#

Response#

Error Responses#

Validation Error Messages#