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.
Create a new group
Create a new community group for sharing reflections. Groups can be public or private, and the creator becomes the owner.
application/json
Request Body required
Group creation details including name, description, URL, and visibility
name string required
Possible values: non-empty and <= 50 characters
description string
Possible values: <= 200 characters
url string required
Possible values: non-empty and <= 50 characters
public boolean
hideFollowJoinButton boolean
Responses
- 201
- 400
- 401
Group created successfully
application/json
Schema
Example (from schema)
Example
Schema
success boolean required
data object required
id number required
name string required
description string required
roomType string required
isActive boolean required
isVerified boolean required
isPublic boolean required
hideFollowJoinButton boolean required
isOwner boolean required
isAdmin boolean required
ownerId string required
postsCount number required
membersCount number required
url string
avatarUrls object required
thumb string
original string
createdAt date-time
isMember boolean
subdomain string
country string
{
"success": true,
"data": {
"id": 0,
"name": "string",
"description": "string",
"roomType": "string",
"isActive": true,
"isVerified": true,
"isPublic": true,
"hideFollowJoinButton": true,
"isOwner": true,
"isAdmin": true,
"ownerId": "string",
"postsCount": 0,
"membersCount": 0,
"url": "string",
"avatarUrls": {
"thumb": "string",
"original": "string"
},
"createdAt": "2026-06-14T08:29:34.273Z",
"isMember": true,
"subdomain": "string",
"country": "string"
}
}
{
"success": true,
"data": {
"id": 1,
"name": "string",
"description": "string",
"roomType": "string",
"isActive": true,
"isVerified": true,
"isPublic": true,
"hideFollowJoinButton": true,
"isOwner": true,
"isAdmin": true,
"ownerId": "string",
"postsCount": 1,
"membersCount": 1,
"url": "string",
"avatarUrls": {
"thumb": "string",
"original": "string"
},
"createdAt": "2026-04-02T00:00:00.000Z",
"isMember": true,
"subdomain": "string",
"country": "string"
}
}
Invalid group data or URL already taken
User not authenticated
Loading...