Update Group

This API updates an existing group, including its name and description.

Endpoint Details

URL	/v1/auth/groups/id
Method	PUT
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Request Path

To update an existing group, use the following request format:

/v1/auth/groups/c10ac748-6218-4bd6-9ca0-97ea933da3d6

---

Path Parameter

Parameter	Type	Description
id	UUID	Unique identifier of the group to update

---

Request Body

Use the following format to make a request:

JSON Request

{
  "name": "Group jeje 1",
  "description": "group jeje 1"
}

---

Body Parameters

Parameter	Type	Description
name	String	Updated name of the group
description	String	Optional description of the group

---

Response

Here is an example response when the data is successfully updated:

Response

{
    "group": {
        "id": "c10ac748-6218-4bd6-9ca0-97ea933da3d6",
        "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
        "name": "Group Jeje 1",
        "description": "group jeje 1",
        "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "created_at": 1784085536,
        "updated_at": 1784085846,
        "member_count": 1
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the group
tenant_id	UUID	Identifier of the tenant that owns the group
name	String	Name of the group
description	String	Description of the group
created_by	UUID	Identifier of the user who created the group
updated_by	UUID	Identifier of the user who last updated the group
created_at	Integer	Group creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format
member_count	Integer	Number of members in the group

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing group.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.