Team Invites

Create a team invitation

Changed on

Invite a user to join a team by email. Team key can be ID or slug. Creates a pending invitation with a secure token that expires in 7 days. The invited user will receive an email with an acceptance link.

post/teams/{key}/invites

Request

  • Base URL: https://api.session.services
  • URL: https://api.session.services/teams/{key}/invites
  • Auth: API key in header x-tenant-id

Path parameters

keystring required

Team identifier (ID or slug)

Request body

emailstring email required

Email address of the user to invite

roleIdsstring[] required

Role IDs to grant to the invited user.

Response

OK

Example response

{
  "invite": {
    "permissions": []
  }
}

Changes