DELETE /sms/lines/{line}/scheduled/{id}
Cancel a scheduled message
| Scope | sms:write |
| Role permission | Phone numbers — line must be one of theirs |
| Cost | Free — and it prevents the future charge. |
Cancelling requires only sms:write: stopping a charge is not a
money-spending action, and requiring sms:send to undo one would be the
wrong way round.
Path parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
line | string | yes | 12125550188 | One of your account's numbers. Digits. |
id | integer | yes | 55120 | The scheduled-message id. |
Responses
204
Cancelled.
Errors
| Status | Meaning |
|---|---|
400 | invalid_request — a missing or malformed field, an unknown enum value, or an unknown field in the body. Nothing was charged. |
401 | unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted. |
403 | Two different failures share this status, and the type tells them apart: |
500 | internal_error — something failed on our side. For a send, nothing was charged, guaranteed, which is what makes a retry safe. |
See Errors for the full catalog and what to do about each.
Example
curl -X DELETE 'https://api.account.telebroad.com/api/public/v1/sms/lines/12125550188/scheduled/55120' \
-H "Authorization: Bearer $TB_KEY"