Messaging

Create a notification. Roles: admin, group member.

Changed on
post/api/notifications

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/notifications
  • Auth
    AuthToken (a scheme the document does not define)

Request body

subjectstring required
bodyHtmlstring required
bodyTextstring
previewTextstring
triggerTimestring date-time required
replyToEmailstring
senderNamestring
imageUuidstring uuid
linkLabelstring
linkUrlstring
eventNonRegistrantsIncludedboolean required
sendEmailboolean required
sendPushboolean required
sendSmsboolean required
membershipIdinteger required
typeCode'EVENT' | 'GROUP' | 'MEMBER' | 'ORG' required
groupIdinteger
groupRoleIdinteger
memberIdinteger
eventIdinteger
messagingListIdinteger

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

  • 36f72442f0a1Revision changes
    • info

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

    • info

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