Webhooks
Delete a webhook
Removes the subscription and stops all deliveries to its URL. The response is 200 with {"status":"ok"}. To stop deliveries temporarily and keep the configuration, set active to false with PUT /webhooks/{id} instead.
DELETE
/
webhooks
/
{id}
cURL
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/sms/webhooks/{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.webhooks.delete_webhook(
id="2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
)
const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/webhooks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "ok"
}{
"error": "missing or invalid credentials"
}{
"error": "subscription not found"
}{
"error": "internal error"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Path Parameters
The subscription id (UUID) to delete.
Response
Deleted.
Confirmation returned by actions that have no resource to return, such as marking a conversation read or creating or deleting an opt-out.
Always ok when the action succeeded.
Example:
"ok"
Was this page helpful?
⌘I
cURL
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/sms/webhooks/{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.webhooks.delete_webhook(
id="2a4c6e8f-1b3d-4f5a-8c7e-9d0b2f4a6c8e",
)
const options = {
method: 'DELETE',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/webhooks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "ok"
}{
"error": "missing or invalid credentials"
}{
"error": "subscription not found"
}{
"error": "internal error"
}