curl --request DELETE \
--url https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123 \
--header 'Authorization: <api-key>'
const response = await fetch(
"https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123",
{
method: "DELETE",
headers: {
Authorization: "<api-key>",
},
}
);
// 204 No Content — response body is empty
const ok = response.status === 204;
import requests
response = requests.delete(
"https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123",
headers={"Authorization": "<api-key>"},
)
# 204 No Content — response body is empty
ok = response.status_code == 204
<?php
$ch = curl_init("https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
],
]);
curl_exec($ch);
// 204 No Content — response body is empty
$ok = curl_getinfo($ch, CURLINFO_HTTP_CODE) === 204;
(empty response body)
{
"errors": [
{
"status": "404",
"title": "Not Found",
"detail": "Webhook subscription 'whsub_abc123' not found"
}
]
}
Managing Subscriptions
Delete a webhook subscription
Permanently delete a webhook subscription and stop all deliveries to it.
DELETE
/
v1
/
webhook-subscriptions
/
{id}
curl --request DELETE \
--url https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123 \
--header 'Authorization: <api-key>'
const response = await fetch(
"https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123",
{
method: "DELETE",
headers: {
Authorization: "<api-key>",
},
}
);
// 204 No Content — response body is empty
const ok = response.status === 204;
import requests
response = requests.delete(
"https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123",
headers={"Authorization": "<api-key>"},
)
# 204 No Content — response body is empty
ok = response.status_code == 204
<?php
$ch = curl_init("https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
],
]);
curl_exec($ch);
// 204 No Content — response body is empty
$ok = curl_getinfo($ch, CURLINFO_HTTP_CODE) === 204;
(empty response body)
{
"errors": [
{
"status": "404",
"title": "Not Found",
"detail": "Webhook subscription 'whsub_abc123' not found"
}
]
}
Permanently delete a webhook subscription. Deliveries to its URL stop immediately. This cannot be undone. To pause deliveries without deleting, set
is_active to false with update instead.
Path parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The webhook subscription ID |
Response
Returns204 No Content with an empty response body on success.
Errors
| Status | Scenario |
|---|---|
401 | Missing or invalid API key |
403 | The API key is read-only and cannot perform write operations |
404 | No subscription with this ID exists for the shop |
429 | Rate limit exceeded (6 requests/second) |
curl --request DELETE \
--url https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123 \
--header 'Authorization: <api-key>'
const response = await fetch(
"https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123",
{
method: "DELETE",
headers: {
Authorization: "<api-key>",
},
}
);
// 204 No Content — response body is empty
const ok = response.status === 204;
import requests
response = requests.delete(
"https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123",
headers={"Authorization": "<api-key>"},
)
# 204 No Content — response body is empty
ok = response.status_code == 204
<?php
$ch = curl_init("https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
],
]);
curl_exec($ch);
// 204 No Content — response body is empty
$ok = curl_getinfo($ch, CURLINFO_HTTP_CODE) === 204;
(empty response body)
{
"errors": [
{
"status": "404",
"title": "Not Found",
"detail": "Webhook subscription 'whsub_abc123' not found"
}
]
}
⌘I