Team

Invite someone to the team

Emails an invitation link that is valid for 7 days. The person signs in with the invited address to accept. Inviting the same address again sends a fresh link. Needs a paid plan and a free seat. Limited to 20 invitations an hour per inviter and 3 an hour per address. Owner or admin only; requires the team:manage scope.

post/v1/team/invites

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/team/invites
  • Auth: HTTP bearer

Request body

emailstring email required
role'admin' | 'member'

Response

The invitation

object'team_invite' required
idstring required
emailstring email required
role'admin' | 'member' required
created_atstring date-time
expires_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.