Platform API

<back to all web services

UpdateNotification

Updates an existing notification

Requires Authentication
The following routes are available for this service:
POST/api/notification/update
UpdateNotification Parameters:
NameParameterData TypeRequiredDescription
NotificationbodyNotificationNo
Notification Parameters:
NameParameterData TypeRequiredDescription
NotificationIdformGuidNo
NotificationGroupIdformGuidNo
NotificationGroupNameformstringNo
SuiteIdformGuidNo
SuiteNameformstringNo
NotificationValueIdformGuidNo
RolesformList<NotificationRole>No
RolesToDisplayformstringNo
NameformstringNo
DescriptionformstringNo
IsMandatoryformboolNo
IsCardinalityformboolNo
IsSystemformboolNo
IsAuditformboolNo
IsVisibleToRecipientsformboolNo
IsSingleUseformboolNo
EmailformboolNo
EmailDefaultformboolNo
EmailTemplateIdformGuidNo
EmailTemplateBodyformstringNo
EmailSubjectformstringNo
SMSformboolNo
SMSDefaultformboolNo
SMSTemplateIdformGuidNo
SMSTemplateBodyformstringNo
UpdateNotificationformboolNo
UpdateNotificationDefaultformboolNo
UpdateTemplateIdformGuidNo
UpdateTemplateBodyformstringNo
UpdateSubjectformstringNo
PushformboolNo
PushDefaultformboolNo
PhoneformboolNo
PhoneDefaultformboolNo
ContactIdOwnerformGuidNo
RecordStatusformstringNo
EmailTemplateDefinitionIdformGuidNo
SMSTemplateDefinitionIdformGuidNo
UpdateTemplateDefinitionIdformGuidNo
IndexformintNo
NotificationRole Parameters:
NameParameterData TypeRequiredDescription
RoleIdformGuidNo
RoleNameformstringNo

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 /api/notification/update HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Notification":{"NotificationId":"00000000-0000-0000-0000-000000000000","NotificationGroupId":"00000000-0000-0000-0000-000000000000","NotificationGroupName":"String","SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","NotificationValueId":"00000000-0000-0000-0000-000000000000","Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String"}],"RolesToDisplay":"String","Name":"String","Description":"String","IsMandatory":false,"IsCardinality":false,"IsSystem":false,"IsAudit":false,"IsVisibleToRecipients":false,"IsSingleUse":false,"Email":false,"EmailDefault":false,"EmailTemplateId":"00000000-0000-0000-0000-000000000000","EmailTemplateBody":"String","EmailSubject":"String","SMS":false,"SMSDefault":false,"SMSTemplateId":"00000000-0000-0000-0000-000000000000","SMSTemplateBody":"String","UpdateNotification":false,"UpdateNotificationDefault":false,"UpdateTemplateId":"00000000-0000-0000-0000-000000000000","UpdateTemplateBody":"String","UpdateSubject":"String","Push":false,"PushDefault":false,"Phone":false,"PhoneDefault":false,"ContactIdOwner":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","EmailTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","SMSTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","UpdateTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","Index":0}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}