Cancel Scheduled Message | Pinnacle

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.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.messages.schedule.cancel("id");
8	}
9	main();

Authentication

Path parameters

Response

Errors