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.

Update a group

Update group properties like name, description, URL, avatar, country, or public visibility. Only group admins/owners can update.

application/json

Request Body required

Group fields to update - all fields optional except id

id number required
name string

Possible values: non-empty and <= 50 characters

description string

Possible values: <= 200 characters

url string

Possible values: non-empty and <= 50 characters

removeAvatar boolean
avatar string

Possible values: Value must match regular expression /^data:image\/[a-z]+;base64,/

country string nullable
public boolean nullable
hideFollowJoinButton boolean nullable

Responses

• 200
• 401
• 403

---

Group updated successfully

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean
room object

{
  "success": true,
  "room": {}
}

{
  "success": true,
  "room": {}
}

User not authenticated

User not authorized to update this group

Loading...