Add or update preference

Add or update one user preferences group like favorite Tafsirs or 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

anyOf

MOD1

MOD2

MOD3

MOD4

MOD5

MOD6

MOD7

MOD8

MOD9

MOD10

MOD11

MOD12

MOD13

MOD14

MOD15

MOD16

MOD17

MOD18

MOD19

key string

Possible values: [type]

key string

Possible values: [readingPreference, selectedWordByWordLocale, wordClickFunctionality]

key string

Possible values: [tafsirFontScale, quranTextFontScale, translationFontScale, wordByWordFontScale, quranFont, mushafLines]

key string

Possible values: [selectedTranslations]

key string

Possible values: [selectedTafsirs]

key string

Possible values: [reciter, playbackRate, showTooltipWhenPlayingAudio, enableAutoScrolling]

key string

Possible values: [language]

value string

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

value string

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

value string

Possible values: [translation, reading]

value string

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

value string

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

value string

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

value string

Possible values: [15_lines, 16_lines]

value integer

Possible values: >= 1 and <= 10

value integer

Possible values: >= 1 and <= 6

value integer

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

group string required

Possible values: [tafsirs, translations, audio, theme, quranReaderStyles, reading, language]

The preference group to be added or updated.

key string required

The preference key to be added or updated.

value required

The preference value to be added or updated.

Responses

Request has been handled successfully.

application/json

Schema

Example (from schema)

Schema

success boolean

data object

message

Possible values: [preference 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"
  }
}

Add or update preference​

Add or update preference