Cancel scheduled message - Automate.ax

highlevel.cancelScheduledMessage cancels one scheduled non-email message before delivery. Use highlevel.cancelScheduledEmailMessage for email.

automations/highlevel-cancel-scheduled-message.automation.ts

import { automation, markSignificant } from "automate.ax"
import { highlevel } from "automate.ax/highlevel"

export default automation("Cancel scheduled message", () => {
  markSignificant(
    highlevel.cancelScheduledMessage({
      messageId: "ve9EPM428h8vShlRW1KT",
    }),
  )
})

Input

Field	Type	Required	Description
`messageId`	`string`	Yes	HighLevel message id value.

Automate.ax supplies the connected sub-account’s location ID. Optional second argument { account } selects a named HighLevel binding.

Output

Field	Type	Required	Description
`status`	`number`	Yes	HTTP Status code of the request
`message`	`string`	Yes	Error message of the request

This action calls DELETE /conversations/messages/{messageId}/schedule with HighLevel API version 2021-04-15 and requires conversations/message.write. HighLevel validation and permission errors fail the action. Rate limits honor the provider’s retry timing.