Home
API reference
Platform API reference
Platform API
Filters
Delete link (beta)

Delete link (beta)

delete/v1/operations/filterLinks/{filterLinkId}
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 link (beta)

Delete an existing link for a filter to a given subscription.

Successfully deleting a link means that the filter will no longer be applied to the subscription’s traffic.

Request parameters and payload

cURL request example

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

Path Parameters

  • Displays the unique identifier of the filter link.

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.