Skip to main content

Invite team members

POST 
/v2/orgs/:org_id/teams/:team_id/members

Invites a new Miro user to an existing team. The user must exist in your Miro organization. Users who do not exist in your Miro organization can be invited to the team via SCIM and an external identity provider, such as Okta or Azure Active Directory.

Required scope

organizations:teams:write

Rate limiting

Level 2

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request​

Path Parameters

    org_id stringrequired

    The id of the Organization.

    Example: 3074457345618265000
    team_id stringrequired

    The id of the Team.

    Example: 3074457345618265000

Body

required

    email stringrequired

    User email to add to a team

    role string

    Possible values: [member, admin, team_guest]

    Role of the team member.

    • "member": Team member with full member permissions.
    • "admin": Admin of a team. Team member with permission to manage team.
    • "team_guest": Team-guest user, user with access only to a team without access to organization.

Responses​

Invitation result object

Schema

    id stringrequired

    Team member id.

    role stringrequired

    Possible values: [non_team, member, admin, team_guest]

    Role of the team member.

    • "member": Team member with full member permissions.
    • "admin": Admin of a team. Team member with permission to manage team.
    • "non_team": External user, non-team user.
    • "team_guest": Team-guest user, user with access only to a team without access to organization.
    createdAt date-time

    Date and time when member was invited to the team.

    createdBy string

    Id of the user who invited the team member.

    modifiedAt date-time

    Date and time when the user's membership was last updated.

    modifiedBy string

    Id of the user who last updated the user's membership.

    teamId stringrequired

    Team id

    type string

    Default value: team-member

    Type of the object returned.

Loading...