notification

Notification Edit

Changed on

Edit a Notification

put/notification/{notificationId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/notification/{notificationId}
  • Auth
    none declared

Path parameters

notificationIdinteger required

The NotificationId

Request body application/x-www-form-urlencoded

subjectstring required

The Subject

bodystring

The Body

releaseDtstring required

ISO date representing the release date for this notification

isInterruptinteger required

Flag indication whether this notification should interrupt the web portal nativation/login

displayGroupIdsinteger[] required

The display group ids to assign this notification to

userGroupIdsinteger[] required

The user group ids to assign to this notification

Response

successful operation

notificationIdinteger

The Notifcation ID

createDtinteger

Create Date as Unix Timestamp

releaseDtinteger

Release Date as Unix Timestamp

subjectstring

The subject line

typestring

The Notification type

bodystring

The HTML body of the notification

isInterruptinteger

Should the notification interrupt the CMS UI on navigate/login

isSysteminteger

Flag for system notification

userIdinteger

The Owner User Id

filenamestring

Attachment filename

originalFileNamestring

Attachment originalFileName

nonusersstring

Additional email addresses to which a saved report will be sent

canEditboolean

Flag indicating whether the current user can edit this notification

canDeleteboolean

Flag indicating whether the current user can delete this notification

Changes

  • 622fb073aecdRevision changes
    • info

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

  • fe497e811c7fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status