Skip to main content
PATCH
Update a notification subscription

Authorizations

Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support. A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Path Parameters

id
string<uuid>
required

The universally unique identifier of the resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Body

application/json

Schema for the request payload to update a new subscription.

name
string
required

Name of the subscription.

Example:

"Transactions Webhook"

enabled
boolean
required

Whether the subscription is enabled. true indicates the subscription is active.

Example:

true

Response

Successfully updated notification subscription.

data
Subscription · object

Contains information about a webhook notification subscription.