Skip to main content
PATCH
/
v2
/
notifications
/
subscriptions
/
{id}
Update a notification subscription
curl --request PATCH \
  --url https://api.circle.com/v2/notifications/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Transactions Webhook",
  "enabled": true
}'
{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "name": "Transactions Webhook",
    "endpoint": "https://example.org/handler/for/notifications",
    "enabled": true,
    "createDate": "2023-01-01T12:04:05Z",
    "updateDate": "2023-01-01T12:04:05Z",
    "notificationTypes": [
      "*"
    ],
    "restricted": false
  }
}

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.

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
object

Contains information about a webhook notification subscription.