Skip to main content

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.

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.

Path Parameters
    slot integer required

    Possible values: >= 1 and <= 3

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

Request Body
    name string nullable required

    Optional custom name. Null uses the localized default name.

    clientUpdatedAt date-time
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.

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
    clientUpdatedAt date-time nullable required
Loading...