Cancel Scheduled Message | Pinnacle

Cancel a previously scheduled message before it is sent.

Use the scheduleId returned from a scheduled send request (SMS, MMS, or RCS) to cancel the message. Once cancelled, the scheduled message will stop being sent.

Note: You cannot cancel a message that has already been sent.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired>=1 character

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.

successboolean

Indicates whether the scheduled message 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.cancel("msg_sched_1234567890");
8	}
9	main();

Authentication

Path parameters

Response

Errors