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.

Edit user profile

Partially update the authenticated user settings and preferences like notification settings, privacy options, and display preferences.

application/json

Request Body required

Settings fields to update - only include fields you want to change

languageId number
reflectionLanguages string[]
ayahLanguages string[]
customized boolean

Default value: false

hideFollowSuggestion boolean

Hide follow suggestion popup after liking a post

showFollowFeaturedSuggestion boolean

Show featured follow suggestion popup on QR onboarding

Responses

• 200
• 400
• 401

---

Settings updated successfully

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean

{
  "success": true
}

{
  "success": true
}

Invalid settings data

User not authenticated

Loading...