Skip to main content
PUT
/
api
/
v3
/
groups
/
{id}
Fully update a group (PUT)
curl --request PUT \
  --url https://paradigm.lighton.ai/api/v3/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<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: Fully update an existing user group (PUT) - requires all fields

name
string
required

Name of the group

Maximum string length: 255
description
string | null

Description of the group

user_ids
integer[]

List of user IDs to set as group members (replaces existing members)

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