Update a subscription

Authorizations

Authorization

string

header

required

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

data

object

data.alert_config

object

subscription config

data.created_at

string

data.deleted_at

string

data.device_metadata

object

data.endpoint_metadata

object

data.filter_config

object

data.function

string

data.name

string

data.rate_limit_config

object

data.retry_config

object

data.source_metadata

object

data.source_metadata.body_function

string

data.source_metadata.created_at

string

data.source_metadata.custom_response

object

data.source_metadata.deleted_at

string

data.source_metadata.forward_headers

string[]

data.source_metadata.header_function

string

data.source_metadata.idempotency_keys

string[]

data.source_metadata.is_disabled

boolean

data.source_metadata.mask_id

string

data.source_metadata.name

string

data.source_metadata.project_id

string

data.source_metadata.provider

enum<string>

Available options:

github,

twitter,

shopify

data.source_metadata.provider_config

object

data.source_metadata.pub_sub

object

data.source_metadata.type

enum<string>

Available options:

http,

rest_api,

pub_sub,

db_change_stream

data.source_metadata.uid

string

data.source_metadata.updated_at

string

data.source_metadata.url

string

data.source_metadata.verifier

object

data.type

enum<string>

Available options:

cli,

api

data.uid

string

data.updated_at

string

message

string

status

boolean

Introduction

Endpoints

Event Deliveries

Event Types

Delivery Attempts

Events

Meta Events

Portal Links

Sources

Subscriptions

Update a subscription

Authorizations

Path Parameters

Body

Response