Skip to main content
PATCH
/
api
/
v3
/
groups
/
{id}
Partially update a group (PATCH)
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>"
}
'
{
  "id": 123,
  "company_id": 123,
  "category": "<string>",
  "name": "<string>",
  "description": "<string>",
  "user_ids": "<string>",
  "assigned_to": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

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

Group updated successfully

V3 Response serializer for retrieving group details. Returns detailed group information including assigned workspaces.

id
integer
required
company_id
integer
required
category
string
required
name
string
required
description
string
required
user_ids
string
required
assigned_to
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required