POST ppservice/residents/{uniqueId}/preferences
Allows Parcel Pending vendor to update resident preferences
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| uniqueId |
Unique email ID |
string |
Required |
Body Parameters
ResidentPreferences object that captures a resident's preferences
ResidentPreferences| Name | Description | Type | Additional information |
|---|---|---|---|
| NotifyByEmail |
Alert user about a pending parcel by email |
boolean |
None. |
| NotifyByPNS |
Alert user about a pending parcel by push notification |
boolean |
None. |
| NotifyByText |
Alert user about a pending parcel by text |
boolean |
None. |
| ADAEnabled | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"NotifyByEmail": true,
"NotifyByPNS": true,
"NotifyByText": true,
"ADAEnabled": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
void
None.