recitations

Partially update a Recitation record

Changed on
patch/recitations/{id}/

Request

  • The document declares no server URL.
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

A UUID string identifying this recitation.

Request body

idstring uuid
mushaf_idstring uuid
get_mushaf_idstring
status'draft' | 'pending_review' | 'published'
  • draft - Draft
  • pending_review - Pending review
  • published - Published
reciter_account_idstring uuid
recitation_datestring date nullable
recitation_locationstring nullable
track_countstring
total_durationstring
recitation_typestring
is_primaryboolean
created_atstring date-time
updated_atstring date-time

Response

idstring uuid required
mushaf_idstring uuid required
get_mushaf_idstring required
status'draft' | 'pending_review' | 'published'
  • draft - Draft
  • pending_review - Pending review
  • published - Published
reciter_account_idstring uuid required
recitation_datestring date nullable
recitation_locationstring nullable
track_countstring required
total_durationstring required
recitation_typestring required
is_primaryboolean
created_atstring date-time required
updated_atstring date-time required

Changes

  • aa7b100ef965Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status