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.

Join a group

Join a public group as a member. For private groups, an invitation is required. Returns whether the join was successful.

Path Parameters

groupId number required

Unique numeric group ID

Responses

• 200
• 401
• 403

---

Successfully joined the group

application/json

Schema

Example (from schema)

Example

---

Schema

joined boolean

{
  "joined": true
}

{
  "joined": true
}

User not authenticated

Group is private - invitation required

Loading...