Reading Bookmarks

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

• Use prelive.quran.com for auth-related testing.
• Use prelive.quranreflect.org for Quran Reflect paths where applicable.
• Do not mix production sessions or production user data with pre-live testing.

Store, move, retrieve, and clear synchronized Quran reading positions.

📄️ Get reading bookmark slots

Get the user's materialized reading bookmark slots ordered by slot. Cleared slots are returned as tombstones; slots that have never been created are omitted.

📄️ 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.

📄️ Clear a reading bookmark slot

Clear a reading bookmark slot without deleting its stable row. Clearing a never-created slot materializes a tombstone so sync can retain the history.

📄️ Rename a reading bookmark slot

Rename a reading bookmark slot without changing its location. A missing slot is materialized as an unplaced named slot. Null restores the localized default name.