Skip to main content

​
Overview

The Teams API lets you invite members to your organization. When an invitation is sent, the invitee automatically receives an email with a link to accept and join the team.

​
Invite member

Invites a user to join your organization. The invitee receives an email notification with their assigned role and a link to the dashboard. 
POST /api/v1/teams/invite
Content-Type: application/json
Authorization: Bearer {API_KEY}

{
  "email": "[email protected]",
  "role": "member"
}

​
Request fields

FieldTypeRequiredNotes
emailstringYesEmail address of the person to invite
rolestringYesRole to assign — e.g. member, admin

​
Behavior

  • Requires the members:invite permission on your token.
  • The invitee receives an email from SelfTune with the inviter’s name, organization name, assigned role, and a link to the dashboard.
  • Email delivery is best-effort and non-blocking — the API responds immediately regardless of email delivery status.

​
Response

{
  "status": "invited"
}

​
Error responses

StatusMeaning
400Invalid request body or missing required fields
403Token lacks members:invite permission
409User is already a member of this organization