PUT - Update Notification

Updating a Notification

🚧

Warning:

When updating a Custom Notification, both the existing parameters and the new parameters must be used in the body of the object.

The PUT customnotification endpoint allows the updating of a specific Custom Notification in the 10-4 Freight Portal.

The PUT HTTP Endpoint for Custom Notification is listed below:

HTTP Verb: POST
URI: https://{domain}.dataview.services.10-4.com/v1/customnotifications
Authentication: Bearer Token

In order to update a Custom Notification using the Custom Notification PUT, the notification GUID will need to be provided in addition to the full new parameters of the notification. An example JSON can be seen below:

{
        	  "notificationGuid": "fdd14e79-0dc5-4f66-b328-aa6cfea0c12c",
            "notificationName": "Stop Notification with Filters",
            "notificationRecipientType": "stoplevel",
            "notificationTypeLabel": "shipmentStatusChange",
            "notificationTypes": [
                "ShipmentStatusEnRoute",
                "ShipmentStatusAtShipper",
                "ShipmentStatusInTransit"
            ],
            "filters": [
                {
                    "propertyName": "ModeType",
                    "propertyValue": "Truckload"
                }
            ],
            "notifyStopContactsByEmail": true,
            "notifyStopContactsBySms": false
        }

Success Response:

{
    "data": [
        {
            "notificationGuid": "fdd14e79-0dc5-4f66-b328-aa6cfea0c12c",
            "notificationName": "Stop Notification with Filters",
            "notificationRecipientType": "stopLevel",
            "notificationTypeLabel": "shipmentStatusChange",
            "notifyStopContactsByEmail": true,
            "notifyStopContactsBySms": false,
            "notificationMetaData": null,
            "notificationTypes": [
                "ShipmentStatusEnRoute",
                "ShipmentStatusAtShipper",
                "ShipmentStatusInTransit"
            ],
            "filters": [
                {
                    "propertyName": "ModeType",
                    "propertyValue": "TruckLoad"
                }
            ],
            "lastUpdateUserName": "[email protected]",
            "lastUpdateDate": "2018-08-16T06:40:15.6778971+00:00",
            "emailList": [],
            "smsList": []
        }
    ],
    "messages": [],
    "totalPossibleCount": 1
}

What’s Next