Subscribe an ERN to receive Push/Pull notifications
This endpoint allows you to subscribe an ERN to receive push/pull notifications (PPN).
Use the POST endpoint Subscribe an ERN to receive Push/Pull notifications to subscribe an ERN to receive push/pull notifications.
Requirements
The user associated with the provided bearer token must have an enrolment that matches the ERN. If no matching enrolment is found, a 403 Forbidden error will be returned.
Path parameters
| Parameter | Type | Details |
|---|---|---|
| ern | String | The ERN to be subscribed to PPN |
Responses
Upon a successful post, this endpoint will return the BoxID that is now associated with that ERN for PPN. Full details of successful and unsuccessful responses and their schema can be found in the API reference on the HMRC Developer Hub.
| Response code | Status | Details | Contents |
|---|---|---|---|
| 202 | Successful | ERN accepted | BoxID |
| 400 | Unsuccessful | Invalid JSON or mandatory fields missing | DateTime, message, debug message |
| 401 | Unsuccessful | Consignor or consignee not authorised. Invalid enrolment parameter. | DateTime, message, debug message |
| 403 | Unsuccessful | Consignor ID or consignee ID in submitted message is not in authorisation bearer token. | DateTime, message, debug message |
| 403 | Unsuccessful | Logged in ERN cannot send this message | DateTime, message, debug message |
| 500 | Unsuccessful | Internal server error. | DateTime, EMCS Correlation ID, message, debug message |
| 503 | Unsuccessful | Downstream service is unavailable. | DateTime, EMCS Correlation ID, message, debug message |
Notes
- When you have already subscribed an ERN to receive Push/Pull notifications and the subscription has not expired, making the call again will return the same response: 202 (ERN accepted).
- Each ERN will need to be subscribed, even in cases where they share a BoxID, in order to receive Push/Pull notifications.