Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Update user profile​

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

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

Profile updated and returned with new values

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
Loading...