Platform API

<back to all web services

UpdateContactNotifications

Updates contact notifications

Requires Authentication
The following routes are available for this service:
PUT/api/contact/{ContactId}/updatenotifications
"use strict";
export class NotificationItem {
    /** @param {{Id?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
}
export class UpdateContactNotifications {
    /** @param {{ContactId?:string,LicenseeId?:string,SuiteId?:string,Notifications?:NotificationItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of contact to get notification for */
    ContactId;
    /**
     * @type {string}
     * @description Id of licensee to get notification for */
    LicenseeId;
    /**
     * @type {string}
     * @description Id of suite to get notification for */
    SuiteId;
    /**
     * @type {NotificationItem[]}
     * @description List of notification to update */
    Notifications = [];
}

JavaScript UpdateContactNotifications DTOs

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 /api/contact/{ContactId}/updatenotifications HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","SuiteId":"00000000-0000-0000-0000-000000000000","Notifications":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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