Messages > schedule

Cancel Scheduled Message

Cancel a scheduled message or blast. <br>

Works for both individual scheduled messages and scheduled blasts. Use the scheduleId returned when the message or blast was scheduled.

delete/messages/schedule/{id}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/messages/schedule/{id}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

idstring required

Unique identifier of the scheduled message. This identifier is a string that always begins with the prefix msg_sched_, for example: msg_sched_1234567890.

Response

Successfully cancelled the scheduled message or blast.

successboolean required

Indicates whether the schedule was successfully cancelled.

Changes

No recorded changes to this operation across all 1 revision of this API.