Skip to main content
PATCH
/
api
/
v1
/
groups
/
{group_id}
Update a group
curl --request PATCH \
  --url https://api.example.com/api/v1/groups/{group_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "name": "<string>",
  "id": "<string>",
  "account_id": "<string>",
  "account_code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "member_count": 0,
  "users": [
    {
      "id": "<string>",
      "email": "<string>",
      "account_id": "<string>",
      "account_code": "<string>",
      "account_name": "<string>",
      "role_id": 123,
      "role_name": "<string>",
      "is_active": true,
      "auth_provider": "<string>",
      "email_verified": true,
      "created_at": "2023-11-07T05:31:56Z",
      "auth_provider_name": "<string>",
      "external_id": "<string>",
      "external_email": "<string>",
      "profile_data": {},
      "email_verified_at": "2023-11-07T05:31:56Z",
      "last_login": "2023-11-07T05:31:56Z"
    }
  ]
}

Path Parameters

​
group_id
string
required

Body

application/json

Schema for updating a group.

​
name
string | null

Group name

Required string length: 1 - 100
​
description
string | null

Group description

Maximum string length: 500

Response

Successful Response

Schema for detailed group response including users.

​
name
string
required

Group name

Required string length: 1 - 100
​
id
string
required

Group ID

​
account_id
string
required

Account ID (UUID)

​
account_code
string
required

Human-readable account code in XX#### format (e.g., AB1234)

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null

Group description

Maximum string length: 500
​
member_count
integer
default:0

Number of users in the group

​
users
UserResponse · object[]

List of users in the group