Skip to main content
PUT
/
v1
/
projects
/
{projectID}
/
subscriptions
/
{subscriptionID}
/
filters
/
{filterID}
Update a filter
curl --request PUT \
  --url https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/{filterID} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": {},
  "event_type": "<string>",
  "headers": {},
  "is_flattened": true
}
'
{
  "message": "<string>",
  "status": true,
  "data": {
    "body": {},
    "event_type": "<string>",
    "headers": {},
    "raw_body": {},
    "raw_headers": {},
    "subscription_id": "<string>",
    "uid": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://getconvoy.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Path Parameters

projectID
string
required

Project ID

subscriptionID
string
required

Subscription ID

filterID
string
required

Filter ID

Body

application/json

Updated filter

body
object

Body matching criteria (optional)

event_type
string

Type of event this filter applies to (optional)

headers
object

Header matching criteria (optional)

is_flattened
boolean

Whether the filter uses flattened JSON paths (optional)

Response

OK

message
string
status
boolean
data
object