Partially update a group (PATCH)

This endpoint allows partially updating a group’s name or description.

PATCH allows updating only the fields you want to change.

Access levels:

• Admin/Sys Admin/Account Manager: Can update any group
• Company Admin: Can update groups in their company

Group name must be unique within the company.

PATCH /api/v3/groups/{id}

Partially update a group (PATCH)

cURL

curl --request PATCH \
  --url https://paradigm.lighton.ai/api/v3/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

200

"<unknown>"

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · integer · required

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

V3 API: Partially update an existing user group (PATCH) - all fields optional

name · string

Name of the group

Maximum string length: 255

description · string | null

Description of the group

Response

200

application/json

Group updated successfully