Unsubscribe to tracking events for a parcel

This endpoint allows a client to unsubscribe from tracking event webhooks for a given parcel identified by its Sendle reference (ref). After unsubscribing, the user will no longer receive webhook notifications for that parcel's tracking events.

This action only affects the authenticated user's subscription and does not impact the tracking status or delivery of the parcel.

Path Params
string
required

The order's unique reference. This is the short ID that can be shared, for example SNFJJ3 or S34WER4S.

This isn't the internal order ID that's used for other API calls.

Headers
string

Name of your service, site, or some other informative value.

Including this lets our team identify your requests and ensures that they aren't blocked by our security tools.

Responses

500

Indicates that an unhandled error has occured with the Sendle API. We may have more information on the Sendle Status page. Contact [email protected] if the problem persists.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*