Skip to main content
Permanently deletes a webhook subscription and all of its event bindings. Once deleted, Portal.io will no longer send event payloads to the associated endpoint. This action cannot be undone — if you need to re-subscribe later, you must create a new subscription with POST /public/webhook/subscribe.
Deletion is immediate and permanent. Ensure you want to stop all deliveries before calling this endpoint.

Request

DELETE /public/webhook/unsubscribe/{SubscriptionId}

Headers

Accept
string
required
Must be application/json.
X-MSS-API-APPID
string
required
Your API Application Key.
X-MSS-API-USERKEY
string
required
Your User API Key.
X-MSS-CUSTOM-DATE
string
required
Current UTC timestamp in RFC 7231 format (e.g. Mon, 06 Apr 2026 00:22:19 GMT).
X-MSS-SIGNATURE
string
required
HMAC-SHA256 signature of the canonical request, Base64-encoded.

Path Parameters

SubscriptionId
integer
required
Numeric ID of the webhook subscription to permanently delete. Must belong to the authenticated account; returns 400 if not found.

Response

200 Success

success
boolean
required
Always true for a successful delete response.
subscriptionId
integer
required
The ID of the subscription that was deleted.

Error Codes

CodeMeaning
400No active webhook subscription with the given SubscriptionId exists for the authenticated account.
401HMAC signature validation failed or credentials are invalid.
402An active Portal.io subscription is required to use this endpoint.
403Your user account does not have permission for this action.

Example

curl -i -X DELETE \
  'https://api.portal.io/public/webhook/unsubscribe/42' \
  -H 'Accept: application/json' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE'
{
  "success": true,
  "subscriptionId": 42
}