10DLC Registration
Delete a campaign
Deletes the campaign from your account and from the US 10DLC registry and returns 204 with no body.
DELETE
/
10dlc
/
campaigns
/
{id}
cURL
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{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.campaigns.delete_campaign(
id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
)
const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": "missing or invalid credentials"
}{
"error": "campaign not found"
}{
"error": "registration provider rejected the request: campaign must be deregistered before deletion",
"providerError": "registration error 403 (HTTP 403): campaign must be deregistered first"
}{
"error": "internal error"
}{
"error": "registration provider unavailable",
"providerError": "registration error 500 (HTTP 500): upstream timeout"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Path Parameters
Campaign ID (UUID) returned by POST /10dlc/campaigns or POST /10dlc/campaigns/toll-free. An unknown ID, an ID from another account, or a value that is not a UUID returns 404 with {"error":"campaign not found"}.
Response
The campaign was deleted. No body.
Was this page helpful?
⌘I
cURL
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{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.campaigns.delete_campaign(
id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
)
const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": "missing or invalid credentials"
}{
"error": "campaign not found"
}{
"error": "registration provider rejected the request: campaign must be deregistered before deletion",
"providerError": "registration error 403 (HTTP 403): campaign must be deregistered first"
}{
"error": "internal error"
}{
"error": "registration provider unavailable",
"providerError": "registration error 500 (HTTP 500): upstream timeout"
}