Broadcasts
Delete a broadcast
Permanently removes a draft or cancelled broadcast together with its recipient list and returns 204 with no body.
DELETE
/
broadcasts
/
{id}
cURL
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/sms/broadcasts/{id} \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.broadcasts.delete_broadcast(
id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
)
const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/broadcasts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": "missing or invalid credentials"
}{
"error": "broadcast not found"
}{
"error": "cannot delete a broadcast that is running"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Path Parameters
The broadcast's id (UUID), as returned by POST /broadcasts or GET /broadcasts. An id that is not a UUID, or that belongs to another account, returns 404 with broadcast not found.
Response
Deleted. No body.
Was this page helpful?
⌘I
cURL
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/sms/broadcasts/{id} \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.broadcasts.delete_broadcast(
id="3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
)
const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/broadcasts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": "missing or invalid credentials"
}{
"error": "broadcast not found"
}{
"error": "cannot delete a broadcast that is running"
}