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]

The id of the Mushaf being used.

1 = QCFV2

2 = QCFV1

3 = Indopak

4 = UthmaniHafs

5 = KFGQPCHAFS

6 = Indopak15Lines

7 = Indopak16Lines

11 = Tajweeed

application/json

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]

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

• 200
• 403
• 404
• 422
• 500

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object

message

Possible values: [preferences updated]

{
  "success": true,
  "data": {}
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ForbiddenError",
    "message": "Token expired"
  }
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "NotFoundError",
    "message": "The resource you're looking for does not exist"
  }
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ValidationError",
    "message": "`id` is required"
  }
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ServerError",
    "message": "Something went wrong"
  }
}

POST /v1/preferences/bulk

Authorization

name: o_t_htype: apiKeyin: header

Request

Base URL

https://auth.quran.com

ApiKeyAuth

mushafId — query required

---123456711

Body

{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}

curl / cURL

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'

python / requests

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'

go / native

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'

nodejs / axios

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'

ruby / Net::HTTP

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'

csharp / RestSharp

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'

php / cURL

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'

java / OkHttp

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'

powershell / RestMethod

curl -L -X POST 'https://auth.quran.com/v1/preferences/bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>' \
--data-raw '{
  "theme": {
    "type": "auto"
  },
  "reading": {
    "readingPreference": "translation",
    "selectedWordByWordLocale": "en",
    "wordClickFunctionality": "play-audio"
  },
  "quranReaderStyles": {
    "tafsirFontScale": 3,
    "quranTextFontScale": 3,
    "translationFontScale": 3,
    "wordByWordFontScale": 3,
    "quranFont": "code_v1",
    "mushafLines": "16_lines"
  },
  "translations": {
    "selectedTranslations": [
      131
    ]
  },
  "tafsirs": {
    "selectedTafsirs": [
      "en-tafisr-ibn-kathir"
    ]
  },
  "audio": {
    "reciter": 7,
    "playbackRate": 1,
    "showTooltipWhenPlayingAudio": true,
    "enableAutoScrolling": true
  },
  "language": {
    "language": "en"
  }
}'