POST /tracking/{trackingNumber}/notifications
This API allows users to register up to three email addresses to receive tracking activity notifications for an item. USPS offers three different tracking activity notification options:
- Delivery Date Updates: Receive a message when the expected delivery date or time window is available or changes. When USPS delivers, transfers, returns, or holds your package for any reason, you will no longer receive expected delivery information.
- Delivery Activity: Receive a message when package has been delivered, delayed, or action is needed (e.g. Schedule Redelivery or Pickup) related to your package.
- All Updates: Receive a message any time there is a new tracking update.
Servers
- https://apis.usps.com/tracking/v3r2
- https://apis-tem.usps.com/tracking/v3r2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
trackingNumber |
String | Yes |
The human-readable representation of trackable barcode data, commonly known as a tracking number. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
uniqueTrackingID |
String | Yes |
The unique tracking identifier provided in the Tracking Detail API response. |
recipients[] |
Array | Yes |
The contact information for up to 3 recipients. |
recipients[].email |
String | Yes |
The email address of the recipient. |
recipients[].lastName |
String | No |
The notification recipient last name. |
recipients[].firstName |
String | No |
The notification recipient first name. |
mailingDate |
String | No |
The mailing date provided in the Tracking Detail API response. |
notifyEventTypes[] |
Array | Yes |
The desired tracking notification(s). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.