Cancel every message of a batch that has not left yet

Before you call

Credential

Authorization: Bearer $KEY

Scope

campaigns:write

Graphql

Mutation.campaignsMailBatchCancel

Sdk

mail.batches.cancel

Cli

mail cancel-batch

Parameters

• idstringrequired
  In the path

Responses

• 200application/json
  Success
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring