PATCH - Update Preferences
The Organization Preferences comprises a JSON Object that ultimately allow users to PATCH the preferences for their organization within 10-4 System's Freight Portal.
Updating a Organization Preferences
The PATCH organizations/me/preferences endpoint allows the updating of a specific organization preference or preferences in the 10-4 Freight Portal.
The PATCH HTTP Endpoint for the Organization Preferences is listed below:
HTTP Verb: PATCH
URI: https://{domain}.organizations.services.10-4.com/v2/organizations/me/preferences
Authentication: Bearer Token
The PATCH organizations preferences endpoint has multiple parameter values that can be included in the object. At lease one of the following parameters must be provided :
1. autoRefreshMinutes
2. isManualShipmentEnabledFlag
3. showPCMilerRouteByDefaultFlag
4. showGoogleRouteByDefaultFlag
5. geofenceRadiusInFeet
6. earlyIsAGoodThing
7. earlyShipmentStatusMinutes
8. onTimeShipmentStatusMinutes
9. inJeopardyShipmentStatusMinutes
10. lateShipmentStatusMinutes
11. hasEarlyStatusDefined
12. hasInJeopardyStatusDefined
13. showPendingShipmentsByDefaultFlag
14. sortOptionFieldType
15. shipmentsToHistoryPageTimeframeInHours
16. autoSetAtConsigneeToDeliveredFlag
17. trackingLostMinutes
18. hasTrackingLostDefined
19. displayDeliveryStatusToDestination
20. dwellTimeEnabled
21. dwellTimeMinutes
22. showEta
23. shipmentExpirationTimeFrameHours
24. temperatureAlertMinutes
25. temperatureAlertBelowMin
26. temperatureAlertAboveMax
27. allowCarrierReportedStopDatesOverride
28. displayCarrierProvidedActualsOnly
29. dropTrailerPickupRulesEnabled
30. dropTrailerDeliveryRulesEnabled
31. isDropTrailerSameDayPickup
32. isDropTrailerSameDayDelivery
33. dropTrailerWindowPickupTimeFrom
34. dropTrailerWindowPickupTimeTo
35. dropTrailerWindowDeliveryTimeFrom
36. dropTrailerWindowDeliveryTimeTo
37. hasRequiredAppointmentEarlyRules
38. etaBaselineIncreaseOrDecrease
39. etaBaselineEnabled
40. etaBaselineMinutes
41. etaHotLoadBaselineIncreaseOrDecrease
42. etaHotloadBaselineEnabled
43. etaHotloadBaselineMinutes
Sample JSON
[
{"op" : "replace", "path" : "isManualShipmentEnabledFlag", "value" : true}
]
See Object Collection for further information.
Success Response:
{
"data": [
{
"autoRefreshMinutes": 15,
"lastEditDate": "2018-09-02T00:21:15.6722337+00:00",
"defaultSortFieldID": 10,
"isManualShipmentEnabledFlag": true,
"showPCMilerRouteByDefaultFlag": true,
"showGoogleRouteByDefaultFlag": false,
"geofenceRadiusInFeet": 2640,
"earlyIsAGoodThing": false,
"earlyShipmentStatusMinutes": null,
"onTimeShipmentStatusMinutes": 240,
"inJeopardyShipmentStatusMinutes": null,
"lateShipmentStatusMinutes": 240,
"hasEarlyStatusDefined": false,
"hasInJeopardyStatusDefined": false,
"showPendingShipmentsByDefaultFlag": false,
"sortOptionFieldType": 10,
"shipmentsToHistoryPageTimeframeInHours": 0,
"autoSetAtConsigneeToDeliveredFlag": false,
"trackingLostMinutes": 120,
"hasTrackingLostDefined": true,
"displayDeliveryStatusToDestination": true,
"dwellTimeEnabled": false,
"dwellTimeMinutes": 0,
"customLogoToken": null,
"showEta": true,
"shipmentExpirationTimeFrameHours": 72,
"temperatureAlertMinutes": 0,
"temperatureAlertBelowMin": 0,
"temperatureAlertAboveMax": 0,
"allowCarrierReportedStopDatesOverride": true,
"displayCarrierProvidedActualsOnly": false,
"dropTrailerPickupRulesEnabled": false,
"dropTrailerDeliveryRulesEnabled": false,
"isDropTrailerSameDayPickup": false,
"isDropTrailerSameDayDelivery": true,
"dropTrailerWindowPickupTimeFrom": null,
"dropTrailerWindowPickupTimeTo": null,
"dropTrailerWindowDeliveryTimeFrom": null,
"dropTrailerWindowDeliveryTimeTo": null,
"hasRequiredAppointmentEarlyRules": false,
"etaBaselineIncreaseOrDecrease": 1,
"etaBaselineEnabled": false,
"etaBaselineMinutes": 0,
"etaHotLoadBaselineIncreaseOrDecrease": 1,
"etaHotloadBaselineEnabled": false,
"etaHotloadBaselineMinutes": 0,
"enablePessimisticFilterFlag": false,
"mobileNotificationDispatchMinutesPriorToScheduledPickup": null
}
],
"messages": [],
"totalPossibleCount": 0
}
Updated about 2 months ago
What’s Next