Add Delivery Status
Required scope:
public-api:write
Description
This endpoint allows to provide updates for a document/publication regarding its status in an external delivery system (e.g. page build status in a static site generator).The response is a JSON object including the
reportId
.Endpoint
POST api/v1/documents/:documentId/addDeliveryStatus
Parameters
Name | Type | Required | Notes |
---|---|---|---|
:documentId | integer | x | |
reportId | string | if provided this will update the record, otherwise it will create a new one with a new reportId | |
publicationId | integer | x | |
deliveryHandle | string | x | |
status | string | x | One of: “success”, “failed”, “in-progress” |
message | string | String or sanitized HTML |