Overview Use Cases Connectors Authentication Getting Started with the Python SDK API API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations docstore document_retrievers documentation eda external_app addAppUserGroupReportPermission addAppUserGroupToExternalApplication addDevelopersToExternalApplication addUserGroupObjectPermission addUsersToAppUserGroup createAppUserGroup createExternalApplication deleteAppUserGroup deleteExternalApplication describeExternalApplication getAppUserGroup getAppUserGroupFromName inviteUsersToAppUserGroup listExternalApplications listUserGroupObjectPermissions removeAppUserGroupFromExternalApplication removeAppUserGroupReportPermission removeDevelopersFromExternalApplication removeUserGroupObjectPermission removeUsersFromAppUserGroup updateExternalApplication updateUserGroupObjectPermission feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps mcp_server_connections model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project project_scopes python_function refresh routellm secrets streaming streaming_connectors upload user webhooks API Classes API Inputs Documentation Chat Bot API Search How to

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: