Bulk replace the members of a custom group you own

Bulk replace the entire member list of a custom group you own.

Only an owner of the group may replace its members; admin roles are not considered. All users must belong to the group’s company. You always remain an owner of your own group, so an empty users array removes every other member but keeps you as the owner. Only custom groups can be modified.

PUT /api/v3/groups/{id}/members

Bulk replace the members of a custom group you own

cURL

curl --request PUT \
  --url https://paradigm.lighton.ai/api/v3/groups/{id}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "id": 123
    }
  ]
}
'

200

{
  "users": [
    {
      "id": 123,
      "email": "<string>",
      "role": "<string>"
    }
  ]
}

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: Bulk replace all group members

users · object[] · required

List of users with their roles. An empty array removes all members from the group.

Show child attributes

Response

200

application/json

Members replaced successfully. Returns all group members with their roles.

The members of a group: {"users": [{id, email, role}, ...]}.

users · object[] · required · read-only

Show child attributes