DELETE `/communication/scheduled/{template_id}`

Cancel a scheduled message send task with a specified ID that is in scheduled status. Messages already sent or failed cannot be canceled. After cancellation, the message status changes to cancelled. References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.

Communication Service `bearerAuth` application/json

Request Parameters

Name	In	Type	Required	Default	Example	Constraints	Description
`id`	`path`	`string`	Yes				Message ID

Request Body

Schema: dto.CancelScheduledRequest

Field	Type	Required	Example	Constraints	Description
`cancel_key`	`string`	No

Responses

Status	Description	Schema
200	Cancellation successful	`dto.OKResponse`
400	Invalid request parameters	`dto.SimpleResponse`
401	Unauthenticated or invalid token	`dto.SimpleResponse`
403	Insufficient permissions to access this resource	`dto.SimpleResponse`
404	Message not found	`dto.SimpleResponse`
409	Message is not in scheduled status, cannot cancel	`dto.SimpleResponse`
500	Internal server error	`dto.SimpleResponse`

Referenced Schemas

dto.OKResponse

Field	Type	Required	Example	Constraints	Description
`code`	`integer`	No	`0`
`message`	`string`	No	`success`

dto.SimpleResponse

Field	Type	Required
`code`	`integer`	No
`message`	`string`	No
`timestamp`	`string`	No

Try this API in Scalar → Download OpenAPI spec (JSON) ↓

DELETE /communication/scheduled/{template_id}