Skip to content

Team invitations

Open .md

API reference Team settings

Email invitations to join your team, with the permission group the person gets.

6 operations

  • GETList invitations/v1/api/store/{team_slug}/setting/inviteReturns the team's invitations that haven't been accepted yet, expired ones included (expired: true).
  • POSTInvite someone to the team/v1/api/store/{team_slug}/setting/inviteInvites a person by email, with the permission group they'll join with, and emails them a link.
  • PUTChange an invitation's permission group/v1/api/store/{team_slug}/setting/invite/{invite}Changes which permission group the person will join with.
  • PATCHChange an invitation with PATCH/v1/api/store/{team_slug}/setting/invite/{invite}Use PUT to change an invitation's permission group.
  • PATCHResend an invitation/v1/api/store/{team_slug}/setting/invite/resend/{invite}Emails the invitation again with a new link.
  • DELETEDelete an invitation/v1/api/store/{team_slug}/setting/invite/{invite}Withdraws an invitation: its link stops working and it no longer counts toward your plan's user limit.