User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

• Use prelive.quran.com for auth-related testing.
• Use prelive.quranreflect.org for Quran Reflect paths where applicable.
• Do not mix production sessions or production user data with pre-live testing.

Invite user to room

Send an invitation to a user to join the room. User will receive a notification/email with an invite link. Only admins can invite.

Path Parameters

id number required

Unique numeric room ID

application/json

Request Body required

User identification for invitation (email or userId)

userIds string[] required
emails string[] required

Responses

• 200
• 401
• 403

---

Invitation sent successfully

application/json

Schema

Example (from schema)

Example

---

Schema

invited boolean required
inviteStatus object required
oneOf

{
  "invited": true,
  "inviteStatus": {
    "user-123": true,
    "user-456": "already_a_member"
  }
}

{
  "invited": true,
  "inviteStatus": {
    "user-123": true,
    "user-456": "already_a_member"
  }
}

User not authenticated

User not authorized to invite members

Loading...