Pages

Create a page. Roles: admin.

Changed on
post/api/pages

Request

  • Base URL
    https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.mobilecoach.org/api/pages
  • Auth
    AuthToken (a scheme the document does not define)

Request body

priorityinteger
isPrivateboolean
titlestring required
subTitlestring
shortTitlestring
detailstring
bodystring
slugstring
publishStartDatestring date
publishEndDatestring date
defaultViewTypestring
defaultSort'ALPHABETICAL' | 'REVERSE_CHRONOLOGICAL' | 'PRIORITY'
sponsorIdinteger
parentPageIdinteger
sharedMembershipTokenstring
sharedPageTokenstring
coverVideoUrlstring
coverImageUuidstring uuid
thumbnailImageUuidstring uuid
contentIdsinteger[]
playlistIdsinteger[]
splashDisplayMaxinteger
externalCssUrlstring
membershipIdinteger
typeCode'BLOCK' | 'BOOK' | 'PAGE' | 'SPLASH' required

Response

OK

successboolean
errorstring

Changes

  • 6e5d224eed9bRevision changes
    • warning

      added the new AGE enum value to the // response property for the response status

    • warning

      added the new GREATER_THAN_OR_EQUALS enum value to the // response property for the response status

    • warning

      added the new LESS_THAN_OR_EQUALS enum value to the // response property for the response status

  • 887e7398ca4aRevision changes
    • info

      added the optional property /// to the response with the status