Sign in
teams

Invite Member

Invite a team member.

Args: team_id: Team identifier. request: Invitation payload. auth: Authenticated caller. service: Team service.

Returns: Created invitation.

post/teams/{team_id}/invitations

Path parameters

team_idstring required

Request body

emailstring email required

Email address of the person to invite

role'owner' | 'billing' | 'admin' | 'editor' | 'viewer'

Team member roles with hierarchical permissions.

Wire DTO mirror of the ORM TeamRoleType enum. Used only for API request/response serialization; authorization decisions route through the ORM matrix (database_tables.permissions), never this enum.

Response

Successful Response

idstring required
team_idstring required
team_namestring required
emailstring required
role'owner' | 'billing' | 'admin' | 'editor' | 'viewer' required

Team member roles with hierarchical permissions.

Wire DTO mirror of the ORM TeamRoleType enum. Used only for API request/response serialization; authorization decisions route through the ORM matrix (database_tables.permissions), never this enum.

status'pending' | 'accepted' | 'declined' | 'expired' required

Status of a team invitation.

invited_bystring required
inviter_namestring nullable
inviter_emailstring nullable
created_atstring required
expires_atstring required
email_sentboolean

Whether the invitation email was successfully handed off to SendGrid. Only meaningful on the create-invite response; list endpoints do not track historical delivery and default to True.

Changes

No recorded changes to this endpoint across all 3 revisions of this API.