Home
API reference
Platform API reference
Platform API
Filters
Delete filter by id (beta)

Delete filter by id (beta)

delete/v1/operations/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 filter by id (beta)

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

You must remove any links before you can successfully delete a filter. To view any existing links, use the Get filter endpoint to review related links.

This endpoint allows you to delete one filter at a time.

Request parameters and payload

cURL request example

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

Path Parameters

  • filterId
    required, string

    Displays the unique identifier of the filter.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "message": "string"
7
  }
8
}
  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object

    Contains a message indicating the request was successful.

    • message
      string

      Explains that the request was successful along with any relevant detail.