Team.invite

Invite a user to this team.

Signature

invite(email: str, role: str='member') -> dict[str, Any]

Parameters

Name	Type	Required	Default
email	str	yes	-
role	str	no	'member'

HTTP parameters

Name	In	Type	Required	Default
team_id	path	string	yes	-

Fields

Schema: InvitationCreateSchema

Field	Type	Required
email	string	yes
project_ids	array<string>	no
role	string	no

Return shape

HTTP 201 — Created

Schema: InvitationSchema

Field	Type	Required
email	string	yes
email_failure_reason	string	no
id	string	yes
invited_by	string	yes
is_accepted	boolean	yes
is_email_failed	boolean	no
project_ids	array<string>	no
role	string	no

Permission

Required permission: team-member:invite

HTTP

POST /api/teams/{id}/invitations (sendInvitation)

Usage

team.invite(email)