update_subscriptionPython,latest
Go to PyPIUpdate subscription endpoint to receive notifications.
Parameters
UpdateSubscriptionRequest
object
Required
name
string
Required
Name of the subscription.
enabled
boolean
Required
Whether the subscription is enabled. true indicates the subscription is active.
id
string
Required
The universally unique identifier of the resource.
x_request_id
string
Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
Responses
Example
1from circle.web3 import configurations
2from circle.web3 import utils
3
4client = utils.init_configurations_client(api_key=key)
5
6api_instance = utils.configurations.WebhookSubscriptionsApi(client)
7request = configurations.UpdateSubscriptionRequest.from_dict({
8 "name": "test",
9 "enabled": True
10})
11response = api_instance.update_subscription(id="d1b66f87-2320-5834-bcd3-175a36a4d331", update_subscription_request=request)
12print(response)
13ResponseChoose 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 "create_date": "2023-01-01T12:04:05Z",
8 "update_date": "2023-01-01T12:04:05Z",
9 "notification_types": [
10 "*"
11 ],
12 "restricted": false
13 }
14}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
