Skip to main content

​
Overview

Permanently removes a webhook subscription. After deletion, no new deliveries will be created for this subscription. Existing delivery records are retained for audit purposes.

​
Endpoint

DELETE /partners/webhooks/subscriptions/:id

​
Authentication

Requires a valid API Key with the partner_webhooks_manage permission.

​
Path Parameters

ParameterTypeRequiredDescription
idUUIDYesThe subscription ID.

​
Example Request

curl -X DELETE "https://apiv3.thecleanlife.dev/v1/partners/webhooks/subscriptions/gggggggg-0000-0000-0000-000000000001" \
  -H "x-api-key: YOUR_API_KEY"

​
Success Response

HTTP Status: 200 OK 
{
  "success": true,
  "data": {
    "id": "gggggggg-0000-0000-0000-000000000001",
    "removed": true
  }
}

​
Error Responses

HTTP StatusCodeDescription
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENMissing partner_webhooks_manage permission
404RESOURCE_NOT_FOUNDSubscription not found

​
Notes

  • Deleted subscriptions cannot be restored. To re-subscribe, create a new subscription (you will receive a new signing secret).
  • To pause deliveries temporarily without deleting, set status: INACTIVE via PATCH instead.