Skip to main content

Reset to Inbox

Reset a previously confirmed inbound parcel back to InBoxReady so it can be downloaded again.

Endpoint

POST /v2/parcels/reset-to-inbox/{id}

Path Parameters

ParameterTypeRequiredDescription
idlongYesUnique identifier of the inbound parcel to reset

:::info When to Use This Use this endpoint when a parcel was confirmed but the local file was lost or corrupted and needs to be re-downloaded. After reset, the parcel will reappear in Pending Inbox List and Inbox List with InBoxReady status. :::

Response

Returns a success boolean indicating whether the parcel was successfully reset.

{
"success": true,
"data": true
}

Code Examples

curl -X POST "https://rest.ecgrid.io/v2/parcels/reset-to-inbox/$ID" \
-H "X-API-Key: $ECGRID_API_KEY"

See Also