Remove list of users from DSGroup

DELETE

/v2.1/organizations/:organizationId/accounts/:accountId/dsgroups/:dsGroupId/users

Removes a list of users from a DSGroup. In the request body, you can specify users by ID or email address. If both parameters are included, the email address parameter will be ignored.

Required authentication scopes: user_write.

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequiredformat: "uuid"

The organization ID GUID

accountIdstringRequiredformat: "uuid"

The account ID GUID

dsGroupIdstringRequiredformat: "uuid"

The DSGroup's GUID.

Request

This endpoint expects an object: dSGroupUsersRemoveRequest

user_idslist of stringsOptional

An array of IDs corresponding to users to remove from the group.

user_emailslist of stringsOptional

An array of emails associated with users to remove from the group. Note: If user_ids is also specified, this parameter will be ignored.

Response

is_successbooleanOptional

failed_userslist of objectsOptional