API ReferenceMessages

Cancel Scheduled Message

Cancel a scheduled message or blast.

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

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired

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
Indicates whether the schedule was successfully cancelled.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
501
Not Implemented Error