Team invitation

A team invitation adds a person to a team a platform created. The team’s first admin is invited automatically when the team is created, so this endpoint is for everyone after that.

{
  "object": "workos_team_invitation",
  "email": "bob@example.com",
  "role_slug": "member"
}

Each role_slug maps to one of the five dashboard roles:

• Invite a team member

Sends an email invitation to the recipient. Inviting an address that already has a pending invitation to this team resends it.

curl --request POST \
  --url "https://api.workos.com/platform/teams/team_01K4BN3VKH8AFZC5J334QZY3PM/invitations" \
  --header "Authorization: Bearer $PLATFORM_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  -d @- <<'BODY'
    {
        "email": "bob@example.com",
        "role_slug": "member"
    }
BODY

{
  "object": "workos_team_invitation",
  "email": "bob@example.com",
  "role_slug": "member"
}

• 400 (user_already_team_member): the person is already an accepted member of this team.
• 400 (user_belongs_to_another_team): the person belongs to a different WorkOS team. A user can only belong to one team, which makes this the most common invitation error in practice.
• 403 (platform_not_authorized): the platform isn’t authorized on this team.
• 404 (team_not_found): no such team.