Base path:
/paper-channel-private/v1This is an internal API. It is not exposed publicly and requires network-level access to the private Paper Channel service.Initialise notification rework
PUT /paper-channel-private/v1/rework/{requestId}/init
Updates the delivery request record and deletes its stored events, preparing the request to accept corrective delivery events from the courier. On success the service returns 204 No Content.
Use case: correcting a notification timeline
Delivery events are occasionally reported out of order or with incorrect data by the courier’s tracking system. When pn-delivery-push detects an inconsistency that must be corrected retroactively:Identify the affected request
Locate the
requestId for the delivery that contains the incorrect timeline entries.Obtain a rework identifier
Generate or receive a
reworkId that uniquely identifies this correction operation. This value is used for audit purposes and to correlate the rework with its trigger.Call initNotificationRework
Submit a
PUT request with the requestId and reworkId. Paper Channel deletes the existing delivery events and marks the request as ready to accept corrective ones.Path parameters
The identifier of the paper delivery request to rework.
- Minimum length: 5
- Maximum length: 100
Query parameters
Unique identifier for this rework operation. Used for audit and correlation purposes.
Responses
| Status | Meaning |
|---|---|
204 | Rework initialised successfully. The request record has been updated and its events deleted. |
400 | Syntactic validation error in the request parameters. |
404 | No delivery request found for the given requestId. |
500 | Internal server error. |