PUT
/
v1
/
projects
/
{projectID}
/
subscriptions
/
{subscriptionID}

Authorizations

Authorization
string
headerrequired

Path Parameters

projectID
string
required

Project ID

subscriptionID
string
required

subscription id

Body

application/json
alert_config
object

Alert configuration

app_id
string

Deprecated but necessary for backward compatibility

endpoint_id
string

Destination endpoint ID

filter_config
object

Filter configuration

function
string

Convoy supports mutating your request payload using a js function. Use this field to specify a transform function for this purpose. See this[https://docs.getconvoy.io/product-manual/subscriptions#functions] for more

name
string

Subscription Nme

rate_limit_config
object

Rate limit configuration

retry_config
object

Retry configuration

source_id
string

Source Id

Response

202 - application/json
message
string
status
boolean
data
object

Was this page helpful?

Retrieve a subscriptionDelete subscription