We refreshed our doc site!

Bookmarked links may have changed

Read release notes

updateSubscription

Web3 Services
Compliance Engine

Update a notification subscription

PATCHhttps://api.circle.com/v2/notifications/subscriptions/{id}

Update subscription endpoint to receive notifications.

Header parameters
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Path parameters
id
uuid
Required

The universally unique identifier (UUID v4) of the resource.

Body parameters
enabled
boolean
Required

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

name
string
Required

Name of the subscription.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4    "name": "Transactions Webhook",
5    "endpoint": "https://example.org/handler/for/notifications",
6    "enabled": true,
7    "createDate": "2023-01-01T12:04:05Z",
8    "updateDate": "2023-01-01T12:04:05Z"
9  }
10}
Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.