Rivier/ Reference/ campaigns

Cancel a scheduled or queued message before it leaves

post/mail/messages/{id}/cancel

Before you call

Credential
Authorization: Bearer $KEY
Scope
campaigns:write
Mcp
rivier_campaign_mail_cancel
Graphql
Mutation.campaignsMailMessageCancel
Sdk
mail.messages.cancel
Cli
mail cancel

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

    This page as Markdown