Add user bookmark

User-related API environment

Production user-related API docs

Add or update a bookmark by details. Omit isReading to create or update a regular standalone bookmark. Set isReading=true to set the user's singleton reading bookmark. Set isReading=false to unset the current reading bookmark; in that case the response data can be null if no reading bookmark was set. For Quran.com-style saved or favorite ayah bookmarks, use POST /v1/collections/__default__/bookmarks.

application/json

Request Body

oneOf

Ayah

Surah, Juz, Or page

key integer required

The Surah number.

type string

Possible values: [ayah]

Default value: ayah

The bookmark type.

verseNumber integer required

The Ayah number to be added.

isReading boolean

Reading bookmark flag. Set true to set the user's current reading bookmark. Set false to unset the current reading bookmark. Omit this field to create or update a regular bookmark.

mushaf 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

key integer required

Surah, Juz or page number.

type string

Possible values: [juz, page, surah]

The bookmark type.

isReading boolean

Reading bookmark flag. Set true to set the user's current reading bookmark. Set false to unset the current reading bookmark. Omit this field to create or update a regular bookmark.

mushaf 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

Responses

Request has been handled successfully.

application/json

Schema

Example (from schema)

Example

Schema

success boolean

data object nullable

id string required

createdAt date-time required

type string required

key integer required

verseNumber integer nullable

group string required

isInDefaultCollection boolean required

isReading boolean nullable required

collectionsCount integer

Collection membership count when the endpoint computes it. Some endpoints may omit this field or default it to 0 when the count is not precomputed.

{
  "success": true,
  "data": {
    "id": "cmnzjryvm00055w0j58ns1xzj",
    "createdAt": "2023-01-21T07:28:13.023Z",
    "type": "ayah",
    "key": 1,
    "verseNumber": 5,
    "group": "verses_6236",
    "isInDefaultCollection": true,
    "isReading": false,
    "collectionsCount": 1
  }
}

{
  "success": true,
  "data": {
    "id": "cmnzjryvm00055w0j58ns1xzj",
    "createdAt": "2023-01-21T07:28:13.023Z",
    "type": "ayah",
    "key": 1,
    "verseNumber": 5,
    "group": "verses_6236",
    "isInDefaultCollection": true,
    "isReading": false,
    "collectionsCount": 1
  }
}

The request is missing required parameters or is invalid.

application/json

Schema

Example (from schema)

Schema

message string

type string

success boolean

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

The request is unauthorized.

application/json

Schema

Example (from schema)

Schema

message string

type string

success boolean

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

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

message string

type string

success boolean

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

Schema

message string

type string

success boolean

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

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

message string

type string

success boolean

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Too many requests, please try again later.

application/json

Schema

Example (from schema)

Schema

message string

type string

success boolean

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

Schema

message string

type string

success boolean

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Invalid response from the upstream server

application/json

Schema

Example (from schema)

Schema

message string

type string

success boolean

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance

application/json

Schema

Example (from schema)

Schema

message string

type string

success boolean

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

The server did not receive a timely response from the upstream server.

application/json

Schema

Example (from schema)

Schema

message string

type string

success boolean

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

Production user-related API docs

Add user bookmark​

Add user bookmark