Cancel scheduled SMS
Cancel a scheduled text or a scheduled campaign before it sends.
POST https://cotlet.dev/api/v1/clicksend/scheduled-sms/cancel
write Confirm
Give message_id to cancel one text scheduled with send_sms, which History cancels with the red X, or campaign_id to cancel a whole scheduled campaign, which the Delete icon does. A campaign cannot lose single recipients, so the whole campaign goes. A cancelled text cannot be edited back; to move it, schedule a new one. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| message_id string | string | Message ID of a scheduled text from list_sms_history. |
| campaign_id integer | integer | Campaign ID from list_sms_campaigns. Give this or message_id. |
Request
curl -X POST https://cotlet.dev/api/v1/clicksend/scheduled-sms/cancel \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("clicksend", "cancel_scheduled_sms")const result = await cotlet.call('clicksend', 'cancel_scheduled_sms');cotlet call clicksend cancel_scheduled_smsExample response
{
"cancelled": "campaign",
"campaign_id": 48213,
"name": "Black Friday teaser",
"recipients": 1840
}