Skip to main content

Create a goal​

Create a goal

Query Parameters
    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

Header Parameters
    x-timezone string

    The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.

Request Body
    type string required

    Possible values: [QURAN_TIME, QURAN_PAGES, QURAN_RANGE, COURSE]

    The type of the goal.

    amount object required

    The amount of the goal. Depending on the goal type, the amount value and format will be different

    oneOf

    string

    The amount of the goal. Depending on the goal type, the amount value and format will be different

    duration integer

    Possible values: >= 1

    The duration of the goal in days. If it's empty it means the goal is a daily goal and not duration-based.

    category string required

    Possible values: [QURAN, COURSE]

    The category of the goal

Responses

Request has been handled successfully.

Schema
    success boolean
    data object
    id string required

    The id of the goal.

Loading...