Method
inviteUsersToAppUserGroup POST
Copy POST

Invite users to an App User Group. This method will send the specified email addresses an invitation link to join a specific user group.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes userGroupId str The ID of the App User Group to invite the user to.
Yes emails list[str] The email addresses to invite to your user group.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result ExternalInvite
KEY TYPE Description
userAlreadyInOrg list List of user emails not successfully invited, because they are already in the organization.
userAlreadyInAppGroup list List of user emails not successfully invited, because they are already in the application group.
userExistsAsInternal list List of user emails not successfully invited, because they are already internal users.
successfulInvites list List of users successfully invited.

Exceptions:

TYPE WHEN
DataNotFoundError

userGroupId is not found.
ConflictError

The specified email is already invited to this user group.
Language:

© Copyright