invite_members_to_org

imerit_ango.sdk.SDK.

invite_members_to_org(organization_id, invite_data)

Send invitations to new members to join your organization.

Parameters

• organization_id: string

  • The unique identifier for the organization. You can find the organization ID in the user interface.

• invite_data: Invitation

  • An Invitation object containing the invitation details, with the following attributes:

  • to: List[str]

    • List of email addresses of the invited members

  • organization_role: OrganizationRoles

    • The role assigned to the invited members within the organization. Options include:

      • OrganizationRoles.Admin

      • OrganizationRoles.Member

  • project_assignments: List[ProjectAssignment], Optional, default None

    • ProjectAssignment

      • project_id: string

        • The unique identifier for the project. You can find the project ID in the user interface or retrieve it using the list_projects function.

      • project_role: ProjectRoles

        • The role assigned to the invited members within the project. Options include:

          • ProjectRoles.Manager

          • ProjectRoles.Labeler

          • ProjectRoles.Reviewer

          • ProjectRoles.Lead

from imerit_ango.models.invite import Invitation, ProjectAssignment
from imerit_ango.models.enums import OrganizationRoles, ProjectRoles

Returns:

• output: dict

  • A dictionary containing the result of the operation.

  • Including a status field indicating whether the request was successful and a data field containing the response payload with updated resources produced by the operation.

How to verify in Ango Hub?

After successfully executing the invite_members_to_org function, you can validate the changes directly in Ango Hub.

Navigate to: Organization → Members

• Confirm that the invited members appear in the list under the invitations.

• Ensure that each user has been invited with the correct role assigned

Changes made via the SDK are reflected in Ango Hub in near real-time. If updates are not immediately visible, please refresh the page.

Example

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK
from imerit_ango.models.invite import Invitation, ProjectAssignment
from imerit_ango.models.enums import OrganizationRoles, ProjectRoles

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
organization_id = os.getenv('ORGANIZATION_ID')

ango_sdk = SDK(api_key)

project_assignment_1 = ProjectAssignment(project_id="PROJECT_ID_1", project_role=ProjectRoles.Labeler),
project_assignment_2 = ProjectAssignment(project_id="PROJECT_ID_2", project_role=ProjectRoles.Reviewer)

project_assignments = [project_assignment_1, project_assignment_2]

invitation = Invitation(
    to=["[email protected]", "[email protected]"],
    organization_role=OrganizationRoles.Member,
    project_assignments=project_assignments
)

response = ango_sdk.invite_members_to_org(
    organization_id=organization_id,
    invite_data=invitation
)

curl

See also

update_organization_members_role, get_organization_invites, add_members_to_project