FlowmageDocs

Cancel scheduled message

BetaChanges data

Stops a scheduled message before it goes out.

Settings

SettingWhat it is
ConnectionRequiredThe Mailchimp Transactional connection the step signs in with.
Message idRequiredThe _id the send answered with. A false in Was still scheduled means the message is no longer scheduled: it was cancelled already, it has gone out, or the id is wrong.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `mailchimp-transactional`)
messageIdtext

Output

FieldType
messageThe cancelled message, empty when there was noneobject
wasScheduledWas still scheduledboolean
Sample output, and the expression for each field
  • message
    • _id"msg-1"
  • wasScheduledtrue

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "messageId": "<message id>"
  },
  "label": "Cancel scheduled message",
  "type": "mandrill.cancelScheduled",
  "version": 1
}