Skip to content
Receiving APIs
/
/
Archive Package

Archive Package

Request

This operation marks the specified package as archived by updating its archived status to true. Archiving a package indicates that its lifecycle is complete, and it is no longer actively tracked. While archived packages are removed from active workflows, their records remain accessible for future reference

Security
bearerAuth
Path
packageIdstringrequired
Example:NeLnz9LZ1j4KK5WlEOlyW
Bodyapplication/json
archivedboolean

set to true to archive the package.

Example:true
curl -i -X PATCH \
  https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack/api/v1/packages/NeLnz9LZ1j4KK5WlEOlyW/archive \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "archived": true
  }'

Responses

Requested package has been marked archived successfully.

Bodyapplication/json
packageIdstring

The unique identifier for the package.

Example:"ma39N30J6YgdxndDpXyOj"
Response
{
  "packageId": "ma39N30J6YgdxndDpXyOj"
}