FRfrain-dev
Subscriptions

Update a subscription

Changed on

This endpoint updates a subscription

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

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project ID

subscriptionIDstring required

subscription id

Request body

app_idstring

Deprecated but necessary for backward compatibility

delivery_mode'at_least_once' | 'at_most_once' | ''
endpoint_idstring

Destination endpoint ID

functionstring

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

namestring

Subscription Nme

source_idstring

Source Id

Response

Accepted

messagestring
statusboolean

Changes