DELETE /api/v1/webhook-subscriptions/{subscriptionId}
Deletes the subscription. It receives nothing more, and its deliveries are no
longer available. To stop deliveries temporarily,
pause it
instead.
| Role in the organization | This endpoint |
|---|
OWNER | Allowed |
ADMIN | Allowed |
MEMBER | Refused — 403 |
| Requirement | Rule for this endpoint |
|---|
| Business role | None beyond the organization role |
| Resource scope | The subscription belongs to the key's organization |
| Participation | None |
| Resource state | Any status |
| Parameter | Type | Required | Description |
|---|
subscriptionId | UUID | yes | Webhook subscription of the key's organization |
| Header | Required | Description |
|---|
x-api-key | yes | API key created for this organization |
Idempotency-Key | yes | Stable key for this command; a replay returns the first result |
X-Correlation-Id | no | Caller correlation id, returned or generated |
curl -X DELETE "$COHORTE_API_BASE_URL/api/v1/webhook-subscriptions/$SUBSCRIPTION_ID" \
-H "x-api-key: $COHORTE_API_KEY" \
-H "Idempotency-Key: webhook-crm-sync-delete-001"
200 OK — the subscription is deleted. replayed: true when the key was already used.400 Bad Request — invalid_request: missing Idempotency-Key.401 Unauthorized — unauthorized: the key is missing, invalid, expired or no longer attached to a member.403 Forbidden — forbidden: the bearer is not OWNER or ADMIN.404 Not Found — not_found: the subscription is unknown or belongs to another organization.500 Internal Server Error — internal_error: unexpected failure.
| Field | Type | Nullable | Description |
|---|
success | boolean | no | true for a successful request |
replayed | boolean | no | true when the idempotency key was already used |
data.deleted | boolean | no | Always true |
correlationId | string | no | Correlation id for support |
{
"success": true,
"replayed": false,
"data": {"deleted": true},
"correlationId": "b7d3e1f0-2a4c-4e8b-9c1d-0f2e3a4b5c6d"
}
- Retrying with the same
Idempotency-Key answers 200 with
replayed: true even though the subscription is already gone. A new key on
a deleted subscription answers 404.
- The deletion is recorded in the organization's audit trail.
