add_members_to_project

imerit_ango.sdk.SDK.

add_members_to_project(project_id, members, role)

Assigns one or more existing organization members to a project with a specific project role.

Parameters

• 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.

• members: List[str]

  • A list of email addresses for the users you want to add to the project.

  • Example: ["[email protected]", "[email protected]"]

• role: ProjectRoles

  • The role in which you would like to add the user(s) to the project.

  • Possible roles include:

    • ProjectRoles.Manager

    • ProjectRoles.Labeler

    • ProjectRoles.Reviewer

    • ProjectRoles.Lead

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.

All specified users must be existing members of the organization. To invite new users, use the invite_members_to_org function.

Example

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK
from imerit_ango.models.enums import ProjectRoles

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

ango_sdk.add_members_to_project(
    project_id=project_id,
    members=["[email protected]", "[email protected]"],
    role=ProjectRoles.Labeler
)

curl

Sample Output

{
  "status": "success",
  "data": {
    "project": {
      "memberUpdates": [
        {
          "assignee": "[email protected]",
          "role": "Labeler"
        },
        {
          "assignee": "[email protected]",
          "role": "Labeler"
        }
      ]
    }
  }
}

See also

invite_members_to_org, get_organization_members