Skip to content

Function: addUserToGroupByGroupId() ​

ts
function addUserToGroupByGroupId(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/v1/api/group.ts:167

Adds a user as a member in a group represented by its groupId

Permissions required: User must be a site admin.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ accountId: string; groupId: string; }-
parameters.accountIdstring-
parameters.groupId?stringGroupId of the group whose membership is updated
options?RequestOptions-

Returns ​

Promise&lt;void>