Sign in
invites

Create multiple invites in bulk

Changed on

Send invitations to multiple users. All rows are validated before any are processed.

post/invites/bulk

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

Example request

{
  "invites": [
    {
      "email": "user@example.com",
      "role": "user",
      "teamNames": [
        "Research",
        "Operations"
      ]
    }
  ]
}

Response

The invites have been processed

totalCountnumber required

Total number of invites in the request

successCountnumber required

Number of invites created successfully

failureCountnumber required

Number of invites that failed

Example response

{
  "totalCount": 10,
  "successCount": 8,
  "failureCount": 2,
  "results": [
    {
      "email": "user@example.com",
      "role": "user",
      "success": true,
      "url": "https://app.example.com/accept-invite?token=abc123",
      "errorCode": "EMAIL_NOT_AVAILABLE",
      "errorMessage": "Email is already registered"
    }
  ]
}

Changes