Skip to content
/
Cancel A Newsletter Dispa...

Cancel A Newsletter Dispatch

Tool name: cancel-newsletter-dispatch

Takes back the dispatch of an email newsletter, so it becomes a draft again and reaches nobody further. THIS IS THE ANSWER TO "stop it", "cancel the send" AND "undo the schedule" -- it covers both a dispatch that is under way and one that is still waiting for a future moment, which the platform treats as two different things and a caller does not have to. Only while the delivery status says canBeCancelled: once a dispatch is far enough along it cannot be called off, and the refusal says so rather than pretending. What already went out stays out -- this stops what has not been sent yet, it does not recall mail. The newsletter itself, its content and its audience are untouched; only the dispatch is undone, and activating it again is prepare-newsletter-dispatch. Ask first: a dispatch someone set up deliberately is not yours to stop on your own reading of a situation.

Input schema

newsletterIdinteger, >= 1required

ID of the newsletter whose dispatch is to be called off

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{
  "newsletterId": 1,
  "accountId": null
}

Output schema

newsletterIdintegerrequired
newsletterStatusstringrequired
dispatchConfiguredbooleanrequired
notestringrequired
Output example
{
  "newsletterId": 0,
  "newsletterStatus": "string",
  "dispatchConfigured": true,
  "note": "string"
}