SDK Explorer

Update subscription endpoint to receive notifications.

Parameters
input
object
Required

Represents the input to update a subscription .

enabled
boolean
Required

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

id
string
Required

Subscription ID.

name
string
Required

Name of the subscription.

Responses
Example
1const response = await client.updateSubscription({
2  id: 'b3d9d2d5-4c12-4946-a09d-953e82fae2b0',
3  name: 'payment-processor',
4  enabled: true,
5})
6console.log(response)
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    "notificationTypes": [
10      "*"
11    ],
12    "restricted": false
13  }
14}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.