Add Users to User Group

//native

type Segment = {

  token: string;

  baseUrl: string;

};

/**

 * Add Users to User Group

 * Adds a list of users or invites to a user group.

• When called, this endpoint may generate one or more of the following audit trail events:* Subjects Added to Group

* User Added To User Group

The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See Rate Limiting for more information.

 */

export async function main(

  auth: Segment,

  userGroupId: string,

  body: { emails: string[] },

) {

  const url = new URL(

    `${auth.baseUrl}/groups/${userGroupId}/users`,

  );

  const response = await fetch(url, {

    method: "POST",

    headers: {

      "Content-Type": "application/json",

      Authorization: "Bearer " + auth.token,

    },

    body: JSON.stringify(body),

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}