Home
API reference
Platform API reference
Platform API
Filters
Delete subscription filter

Delete subscription filter

delete/v0/subscriptions/{subscriptionId}/filters/{filterId}
Page View

Filter endpoints allow you to review and manage filters for async messages. A filter can contain multiple rules, but you can only create one filter per subscription. Learn about filters.

You can retrieve, create, update, or delete filters.

Beta users may also use the endpoints for reviewing and managing filter links.

Delete subscription filter

Delete an existing filter from the subscription you specify in the request.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v0/subscriptions/{subscriptionId}/filters/{filterId}' \
2
--request DELETE \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • subscriptionId
    required, string

    Displays the unique identifier of the subscription that the filter is applied to.

  • filterId
    required, string

    Displays the unique identifier of the filter.

Response fields and example

Example payload generated from schema
1
{
2
  "message": "Successfully removed filter from subscription",
3
  "filterId": "e049f44d-99b2-4790-b4c6-19c0c21d1234",
4
  "subscriptionId": "66426"
5
}
  • message
    string

    Contains an informative message that the filter was deleted.

  • filterId
    string

    Contains the ID of the filter that was deleted.

    Format: uuid
  • subscriptionId
    string

    Contains the ID of the subscription that the filter was deleted from.