Update a subscription

Update a notification subscription’s name, event type, channel, config, scope, or active status.

PUT /api/notifications/subscriptions/{subscriptionId}

Update a subscription

cURL

curl --request PUT \
  --url https://app.demandiq.com/api/notifications/subscriptions/{subscriptionId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "eventType": "<string>",
  "channel": "webhook",
  "channelConfig": {},
  "deckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isActive": true
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "eventType": "<string>",
  "channel": "webhook",
  "channelConfig": {},
  "deckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

subscriptionId · string<uuid> · required

Body

application/json

name · string

eventType · string

channel · enum<string>

Available options: webhook, email, console

channelConfig · object

deckId · string<uuid>

isActive · boolean

Response

200 - application/json

Subscription updated

id · string<uuid>

name · string

eventType · string

channel · enum<string>

Available options: webhook, email, console

channelConfig · object

deckId · string<uuid> | null

isActive · boolean

createdAt · string<date-time>

updatedAt · string<date-time>