Invitations

Create New Invites

Unified endpoint to create invitations for users OR admins based on role.

Authorization:

  • Only admin users can create invitations (for both admins and regular users)
  • Non-admin users will receive 403 Forbidden

For Admin Invitations (role="admin"):

  • Creates Firebase user with SSO authentication
  • Sends activation email with 24-hour expiry token
  • Admin can belong to only one organization
  • Uses business_admins collection

For User Invitations (role != "admin"):

  • Validates emails exist in Firestore
  • Checks users are not already in any business
  • Creates invitation and sends email
  • Uses invitations collection

Request Body:

  • user_emails: List of email addresses
  • role: "admin" | "user"
  • invitation_expiry: Days until expiry (default: 7 for users, 24 hours for admins)
post/api/v1/invitations/create

Request body

user_emailsstring[] required
invitation_expiryinteger nullable
role'admin' | 'manager' | 'viewer' | 'user' nullable
send_email_notificationboolean
country_codestring
mobile_numberstring nullable

Response

Successful Response

success_countinteger required
failed_countinteger required

Changes

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