Update a notification subscription

Update subscription endpoint to receive notifications.

PATCH /v2/notifications/subscriptions/{id}

Update a notification subscription

cURL

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
}
'

200

{}

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<uuid>

Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. Must be a UUID to appear in logs. Non-UUID values are accepted by the API but are ignored by logging and tracing systems.

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

200

application/json

Successfully updated notification subscription.

data · Subscription · object

Contains information about a webhook notification subscription.

Show child attributes