Skip to main content

Add note​

Add a new note.

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.

Request Body
    body string required

    Possible values: >= 6 characters and <= 10000 characters

    The main content of the note, must be between the specified minimum and maximum length.

    saveToQR boolean required

    Indicates whether the note should be saved to the QuranReflect.

    attachedEntity object
    entityId string required

    The unique identifier for the attached entity.

    entityType string required

    Possible values: [reflection]

    The type of the attached entity, must be one of the predefined NoteEntityType values.

    entityMetadata object

    Additional metadata for the attached entity.

    ranges string[]

    Possible values: Value must match regular expression ^(\d+):(\d+)-(\d+):(\d+)$

    An array of verse ranges associated with the note.

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

    The unique identifier of the note.

    createdAt date-time required

    The creation date of the note.

    updatedAt date-time required

    The last update date of the note.

    body string required

    Possible values: >= 6 characters and <= 10000 characters

    The main content of the note, must be between the specified minimum and maximum length.

    source string

    The source of the note.

    attachedEntities object[]

    An array of attached entities associated with the note.

  • Array [
    • entityId string required

    The unique identifier for the attached entity.

    entityType string required

    Possible values: [reflection]

    The type of the attached entity, must be one of the predefined NoteEntityType values.

    entityMetadata object

    Additional metadata for the attached entity.

  • ]
    • ranges string[]

    Possible values: Value must match regular expression ^(\d+):(\d+)-(\d+):(\d+)$

    An array of verse ranges associated with the note.

Loading...