YM REST Services

<back to all web services

SendTestNotification

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/Notification/{NotificationID}/SendTestSend the Test Email Notification.
SendTestNotification Parameters:
NameParameterData TypeRequiredDescription
NotificationIDpathstringNo
NotificationBodybodystringNo
NotificationSubjectbodystringNo
NotificationNamebodystringNo
NotificationFrombodystringNo
NotificationTobodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
SendTestNotificationResponse Parameters:
NameParameterData TypeRequiredDescription
successformboolNo

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

HTTP + CSV

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

POST /Ams/{ClientID}/Notification/{NotificationID}/SendTest HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"NotificationID":"String","NotificationBody":"String","NotificationSubject":"String","NotificationName":"String","NotificationFrom":"String","NotificationTo":"String","UsingRedis":true,"AppInitTime":"2024-09-07T21:34:30.1375632-04:00","ServerID":"WS-5-175-285","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-09-07T23:18:15.4068758-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false}