Deliveries

Update a delivery

Partially updates a delivery. Here {id} is the DELIVERY id, unlike the GET on this same path, which takes the team id.

id, type, team_id and created_at are blacklisted and dropped. Sending a field with the value null removes that attribute from the row rather than setting it to null — this is how you clear an optional config block.

Every patch notifies the coordinator to reload the delivery, because any field can change execution behaviour. Pausing a delivery is done by patching stage.

patch/deliveries/{id}

Request

  • Base URL: https://api.indexone.io
  • URL: https://api.indexone.io/deliveries/{id}
  • Auth: API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Delivery id.

Request body

namestring
stage'live' | 'draft'

Set to draft to pause the delivery.

index_idsstring[]
timezonestring

Example request

{
  "operations": [
    {
      "id": "delivery_trigger"
    }
  ]
}

Response

The updated delivery (ALL_NEW) plus trigger_notification.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.