YM REST Services

<back to all web services

NotificationUpdate

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
PUT/Ams/{ClientID}/Notification/{NotificationID}Update the details of notification.
NotificationUpdate Parameters:
NameParameterData TypeRequiredDescription
NotificationIDpathstringNo
NotificationNamebodystringNo
NotificationDescriptionbodystringNo
NotificationCanDisablebodyboolNo
NotificationIsReadonlybodyboolNo
NotificationIsActivebodyboolNo
NotificationIsCustombodyboolNo
NotificationFrombodystringNo
NotificationSubjectbodystringNo
NotificationBodybodystringNo
NotificationMacroCountbodyintNo
NotificationFromDefaultbodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
NotificationUpdate Parameters:
NameParameterData TypeRequiredDescription
NotificationIDpathstringNo
NotificationNamebodystringNo
NotificationDescriptionbodystringNo
NotificationCanDisablebodyboolNo
NotificationIsReadonlybodyboolNo
NotificationIsActivebodyboolNo
NotificationIsCustombodyboolNo
NotificationFrombodystringNo
NotificationSubjectbodystringNo
NotificationBodybodystringNo
NotificationMacroCountbodyintNo
NotificationFromDefaultbodystringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /Ams/{ClientID}/Notification/{NotificationID} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"NotificationID":"String","NotificationName":"String","NotificationDescription":"String","NotificationCanDisable":false,"NotificationIsReadonly":false,"NotificationIsActive":false,"NotificationIsCustom":false,"NotificationFrom":"String","NotificationSubject":"String","NotificationBody":"String","NotificationMacroCount":0,"NotificationFromDefault":"String","UsingRedis":true,"AppInitTime":"2024-05-03T07:20:07.3002820-04:00","ServerID":"WS-5-155-994","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T07:38:50.4155183-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"NotificationID":"String","NotificationName":"String","NotificationDescription":"String","NotificationCanDisable":false,"NotificationIsReadonly":false,"NotificationIsActive":false,"NotificationIsCustom":false,"NotificationFrom":"String","NotificationSubject":"String","NotificationBody":"String","NotificationMacroCount":0,"NotificationFromDefault":"String","UsingRedis":true,"AppInitTime":"2024-05-03T07:20:07.3002820-04:00","ServerID":"WS-5-155-994","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T07:38:50.4155183-04:00","Device":"Desktop"}