Add users to group

POST https://api.light.inc/v1/user-groups/{userGroupId}/users

Adds users to a user group

Authorization

Send one of these on every request. See Authentication for how to get credentials.

API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Bearer token

Path parameters

userGroupId string · uuidrequired

Request body

application/json;charset=UTF-8

userIds array of string · uuid

Response

This endpoint returns no content.

curl -X POST "https://api.light.inc/v1/user-groups/3c90c3cc-0d44-4b50-8888-8dd25736052a/users" \
  -H "Authorization: Basic YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "userIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}'

const res = await fetch("https://api.light.inc/v1/user-groups/3c90c3cc-0d44-4b50-8888-8dd25736052a/users", {
  method: "POST",
  headers: {
    Authorization: `Basic ${process.env.LIGHT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "userIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }),
});
const data = await res.json();

import os, requests

res = requests.post(
    "https://api.light.inc/v1/user-groups/3c90c3cc-0d44-4b50-8888-8dd25736052a/users",
    headers={"Authorization": f"Basic {os.environ['LIGHT_API_KEY']}"},
    json={
        "userIds": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
    },
)
data = res.json()

Example request

{
  "userIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Generated from the schema: shapes and types are real, values are placeholders, and fields that exclude each other are all shown. Do not send it unchanged.