Add user bookmark

Add a bookmark by details.

Query Parameters

lastMutationAt float required

The timestamp of the last mutation that was applied on the server. Required for any data modification operation to ensure concurrency control.

application/json

Request Body

anyOf

Ayah

Surah, Juz, Or page

key integer required

The Surah number.

type string required

Possible values: [ayah]

Default value: ayah

The bookmark type.

verseNumber integer required

The Ayah number to be added.

isReading boolean

Whether this bookmark is the reading bookmark. Only one reading bookmark per user.

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 required

Possible values: [juz, page, surah]

The bookmark type.

isReading boolean

Whether this bookmark is the reading bookmark. Only one reading bookmark per user.

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.

Response Headers

X-Mutation-At string
Unix timestamp (milliseconds) of the latest mutation for the user. Clients should store this value and include it in subsequent mutation requests for optimistic concurrency control.

application/json

Schema

Example (from schema)

Schema

success boolean

data object

id string required

createdAt date-time required

type string required

key integer required

verseNumber integer

group string

isInDefaultCollection boolean required

{
  "success": true,
  "data": {
    "id": "cmllufw7u000542jq4x0jhz4u",
    "createdAt": "2023-01-21T07:28:13.023Z",
    "type": "ayah",
    "key": 1,
    "verseNumber": 5,
    "group": "string",
    "isInDefaultCollection": true
  }
}

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
}

Out of Sync Error. The client lastMutationAt does not match server state. Client must re-sync data before retrying this operation.

application/json

Schema

Example (from schema)

Out of sync

First sync - wrong lastMutationAt

Schema

success boolean

error object

code string

message string

{
  "success": false,
  "error": {
    "code": "OutOfSyncError",
    "message": "Invalid lastMutationAt, please re-sync your data and try again."
  }
}

{
  "success": false,
  "error": {
    "code": "OutOfSyncError",
    "message": "Invalid lastMutationAt, please re-sync your data and try again."
  }
}

{
  "success": false,
  "error": {
    "code": "OutOfSyncError",
    "message": "First sync detected. Please use lastMutationAt=-1 for initial sync."
  }
}

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
}

Add user bookmark​

Add user bookmark