Teams

Invite a team member

Invite a member to the given team by email. role is required and must be one of admin, developer, or custom. Pass custom together with a non-empty customRoles list to invite a member into a custom role; for admin and developer, customRoles must be omitted.

post/teams/{team_id}/invite_team_member

Request

  • Base URL: https://api.convex.dev/v1
  • URL: https://api.convex.dev/v1/teams/{team_id}/invite_team_member
  • Auth: HTTP bearer

Path parameters

Team ID

Request body

emailstring required
role'admin' | 'developer' | 'custom' required
customRolesCustomRoleId[] nullable

Custom roles to attach when role is custom. Required and non-empty in that case, and forbidden otherwise.

Changes

No recorded changes to this operation across all 11 revisions of this API.