Update a NotificationSubscription

PUT /api/notifications/subscriptions/{id} deprecated

Requires: Notifications.Subscriptions, Notifications.Subscriptions.Update, merchant scope.

Update an existing NotificationSubscription by id

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a NotificationSubscriptionUpdateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/notifications/subscriptions/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "",
  "eventTypes": [
    ""
  ],
  "channelIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "name": "",
  "eventTypes": [
    ""
  ],
  "channelIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/notifications/subscriptions/{id}' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, NotificationsApi } from '@winkpg/winkpg-api';

const api = new NotificationsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.notificationsUpdateSubscriptionsId("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "name": "",
  "eventTypes": [
    ""
  ],
  "channelIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/subscriptions/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "",
    "eventTypes": [
      ""
    ],
    "channelIds": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ]
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new NotificationsApi(config);
var body = JsonSerializer.Deserialize<NotificationSubscriptionUpdateDto>("""
    {
      "name": "",
      "eventTypes": [
        ""
      ],
      "channelIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ]
    }
    """);

var result = await api.NotificationsUpdateSubscriptionsIdAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/notifications/subscriptions/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": "",
      "eventTypes": [
        ""
      ],
      "channelIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ]
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.NotificationsApi(client)
    body = winkpg_api.NotificationSubscriptionUpdateDto.from_dict({
      "name": "",
      "eventTypes": [
        ""
      ],
      "channelIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ]
    })
    result = api.notifications_update_subscriptions_id("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "name": "",
  "eventTypes": [
    ""
  ],
  "channelIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/notifications/subscriptions/{id}",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`name` required	string	Subscription name. nullablemax length 256
`description` required	string	Optional description. nullablemax length 1024
`isEnabled` required	boolean	Whether the subscription is enabled.
`scope` required	all of SubscriptionScope	Organizational scope.
`resellerId` required	string (uuid)	Reseller ID (required for reseller scope). nullable
`merchantId` required	string (uuid)	Merchant ID (required for merchant scope). nullable
`resellerPathPrefix` required	string	Reseller path prefix (required for reseller scope). nullablemax length 512
`eventTypes` required	array of string	Event types to subscribe to (at least one required). nullable
`filterExpressionJson` required	string	Serialized filter expression JSON (null for no filter). nullablemax length 8192
`channelIds` required	array of string (uuid)	Channel IDs to route notifications through. nullable
`concurrencyStamp` required	string	nullable

This request body has no documented fields.