updateDeliveries

The updateDeliveries function allows you to update the send time of a delivery, or cancel an upcoming delivery.

Overview

If you want to change the message used in the delivery, or change the delivery targets, you should first cancel the delivery (set the status to skipped), and then schedule a new delivery (addDeliveries).

Syntax

writeResult = bApi.updateDeliveries(deliveryObject[] delivery);

Attributes

Name Type Required Description
id string Yes The unique id for the delivery.
start dateTime No The date the delivery is scheduled to be sent.
status string No The status of the delivery. Valid values: skipped. Set the status to skipped to cancel the delivery.