Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Upsert a reading bookmark slot​

Create or replace one reading bookmark slot. The slot keeps its stable ReadingBookmark ID while its directly stored location changes. Multiple slots may store the same location.

Request Body
    oneOf

    key integer required

    The Surah number.

    type string required

    Possible values: [ayah]

    Default value: ayah

    verseNumber integer required

    Possible values: >= 1

    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

    slot integer required

    Possible values: >= 1 and <= 3

    One-based reading bookmark slot. Valid values are 1, 2, and 3.

    name string nullable

    Optional custom name. Null uses the localized default name.

    metadata object nullable
Responses

Request has been handled successfully.

Response Headers
  • X-Mutation-At string

    Effective user mutation head in Unix milliseconds. GET returns its observed sync head; writes capture it inside their serialized database operation, before releasing the user lock. Effective writes advance it; no-ops may retain it. Successful publication uses the final attachment transaction; partial publication retains the private-write or pre-publication baseline head. A concurrent write may make it stale before receipt, so POST /v1/sync can still return 409. Use it only as an optimistic write precondition, never as a pull watermark. See the Sync API guide for how sync clients store and use it.


Schema
    success boolean
    data object
    id string required
    slot integer required

    Possible values: >= 1 and <= 3

    One-based reading bookmark slot. Valid values are 1, 2, and 3.

    name string nullable required

    Optional custom name. Null uses the localized default name.

    mushafId integer nullable required
    type string nullable required

    Possible values: [page, juz, surah, ayah]

    group string nullable required
    key integer nullable required
    verseNumber integer nullable required
    metadata object nullable required
    createdAt date-time required
    updatedAt date-time required
    clientCreatedAt date-time nullable required

    Server-maintained creation timestamp; legacy rows may be null.

    clientUpdatedAt date-time nullable required

    Server-maintained last effective change timestamp; request values are ignored.

Loading...