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 user profile

Update user profile information including name, bio, username, avatar, and social links. Validates username uniqueness.

application/json

Request Body required

Profile fields to update wrapped in a user object

user object required
avatar string
Possible values: Value must match regular expression /^data:image\/[a-z]+;base64,/
firstName string
lastName string
bio string nullable
country string nullable
removeAvatar boolean

Responses

• 200
• 400
• 401

---

Profile updated and returned with new values

application/json

Schema

Example (from schema)

Example

---

Schema

avatarUrls object required
settings object

ayahLanguages number[]

reflectionLanguages number[]

customized boolean

hideFollowSuggestion boolean

Hide follow suggestion popup after liking a post

showFollowFeaturedSuggestion boolean

Show featured follow suggestion popup on Quran Reflect onboarding

createdAt string required
joiningYear number required
username string
id string required
verified boolean

Default value: false

postAs boolean

Default value: false

firstName string
lastName string
postsCount number

Default value: 0

languageId number
followersCount number

Default value: 0

likesCount number

Default value: 0

isAdmin boolean

Default value: false

languageIsoCode string

Default value: en

bio string
country string
followed boolean

{
  "avatarUrls": {
    "small": "https://avatars.githubusercontent.com/u/12345678",
    "medium": "https://avatars.githubusercontent.com/u/12345678",
    "large": "https://avatars.githubusercontent.com/u/12345678"
  },
  "settings": {
    "ayahLanguages": [
      0
    ],
    "reflectionLanguages": [
      0
    ],
    "customized": true,
    "hideFollowSuggestion": true,
    "showFollowFeaturedSuggestion": true
  },
  "createdAt": "2000-01-21 00:00:00",
  "joiningYear": 2025,
  "username": "string",
  "id": "string",
  "verified": false,
  "postAs": false,
  "firstName": "string",
  "lastName": "string",
  "postsCount": 0,
  "languageId": 0,
  "followersCount": 0,
  "likesCount": 0,
  "isAdmin": false,
  "languageIsoCode": "en",
  "bio": "string",
  "country": "string",
  "followed": true
}

{
  "avatarUrls": {
    "small": "https://avatars.githubusercontent.com/u/12345678",
    "medium": "https://avatars.githubusercontent.com/u/12345678",
    "large": "https://avatars.githubusercontent.com/u/12345678"
  },
  "settings": {
    "ayahLanguages": [
      1
    ],
    "reflectionLanguages": [
      1
    ],
    "customized": true,
    "hideFollowSuggestion": true,
    "showFollowFeaturedSuggestion": true
  },
  "createdAt": "2000-01-21 00:00:00",
  "joiningYear": 2025,
  "username": "string",
  "id": "string",
  "verified": false,
  "postAs": false,
  "firstName": "string",
  "lastName": "string",
  "postsCount": 0,
  "languageId": 1,
  "followersCount": 0,
  "likesCount": 0,
  "isAdmin": false,
  "languageIsoCode": "en",
  "bio": "string",
  "country": "string",
  "followed": true
}

Invalid profile data or username taken

User not authenticated

Loading...