Skip to main content

Bulk add or update preferences​

Add or update one or more user preferences groups like favorite Tafsirs and translations.

Query Parameters
    mushafId integer required

    Possible values: [1, 2, 3, 4, 5, 6, 7, 11, 19]

    The id of the Mushaf being used.

    1 = QCFV2

    2 = QCFV1

    3 = Indopak

    4 = UthmaniHafs

    5 = KFGQPCHAFS

    6 = Indopak15Lines

    7 = Indopak16Lines

    11 = Tajweeed

    19 = QCFTajweedV4

Request Body
    theme object
    type string

    Possible values: [auto, light, sepia, dark]

    reading object
    readingPreference string

    Possible values: [translation, reading]

    selectedWordByWordLocale string

    Possible values: [en, ur, id, bn, tr, fa, ru, hi, de, ta, inh]

    wordClickFunctionality string

    Possible values: [play-audio, no-audio]

    quranReaderStyles object
    tafsirFontScale integer

    Possible values: >= 1 and <= 10

    quranTextFontScale integer

    Possible values: >= 1 and <= 10

    translationFontScale integer

    Possible values: >= 1 and <= 10

    wordByWordFontScale integer

    Possible values: >= 1 and <= 6

    quranFont string

    Possible values: [code_v1, code_v2, text_uthmani, text_indopak, qpc_uthmani_hafs, tajweed, tajweed_v4]

    mushafLines string

    Possible values: [15_lines, 16_lines]

    translations object
    selectedTranslations integer[]
    tafsirs object
    selectedTafsirs string[]
    audio object
    reciter integer
    playbackRate integer

    Possible values: [0.25, 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2]

    showTooltipWhenPlayingAudio boolean
    enableAutoScrolling boolean
    language object
    language string

    Possible values: [en, ar, bn, fa, fr, id, it, nl, pt, ru, sq, th, tr, ur, zh, ms]

Responses

Request has been handled successfully.

Schema
    success boolean
    data object
    message

    Possible values: [preferences updated]

Loading...