Partially update an Announcement

PATCH /api/announcements/{id} deprecated

Requires: Announcements.Management, Announcements.Management.Update, merchant scope.

Change some fields of an existing Announcement without resending the rest. Send an RFC 7396 merge patch: a field you omit keeps its current value, and an array you send replaces the stored array outright. Sending null clears a field that accepts null, while a field this endpoint requires rejects null and fails validation rather than being cleared. The schema publishes every field that rejects null as not nullable.

Try this in the console

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 UpdateAnnouncementDtoMergePatch. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PATCH "{{BASE_URL}}/api/announcements/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{
  "title": "new value"
}'

PowerShell

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

$body = @'
{
  "title": "new value"
}
'@

$response = Invoke-RestMethod -Method PATCH -Uri '{{BASE_URL}}/api/announcements/{id}' `
    -Headers $headers -ContentType 'application/merge-patch+json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.announcementsMergePatchUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "title": "new value"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/announcements/{id}', {
  method: 'PATCH',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/merge-patch\u002Bjson",
  },
  body: JSON.stringify({
    "title": "new value"
  }),
});

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 AnnouncementsApi(config);
var body = JsonSerializer.Deserialize<UpdateAnnouncementDtoMergePatch>("""
    {
      "title": "new value"
    }
    """);

var result = await api.AnnouncementsMergePatchUpdateAsync(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("PATCH"), "/api/announcements/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "title": "new value"
    }
    """, Encoding.UTF8, "application/merge-patch+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.AnnouncementsApi(client)
    body = winkpg_api.UpdateAnnouncementDtoMergePatch.from_dict({
      "title": "new value"
    })
    result = api.announcements_merge_patch_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/merge-patch\u002Bjson",
}

body = {
  "title": "new value"
}

response = requests.request(
    "PATCH",
    "{{BASE_URL}}/api/announcements/{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/merge-patch+json , required

Field	Type	Description
`title` required	string	The announcement title. min length 3max length 256
`body` required	string	The announcement body content (supports Markdown). min length 10max length 8192
`scope` required	all of AnnouncementScope	The organizational scope of the announcement.
`priority` required	all of AnnouncementPriority	The priority level of the announcement.
`displayOptions` required	all of AnnouncementDisplayOptions	How the announcement should be displayed to users.
`resellerId` required	string (uuid)	The reseller ID for reseller-scoped announcements. Required when Scope is Reseller. Required: When Scope == Reseller. nullable
`merchantId` required	string (uuid)	The merchant ID for merchant-scoped announcements. Required when Scope is Merchant. Required: When Scope == Merchant. nullable
`startDateUtc` required	string (date-time)	When the announcement becomes active. Null means immediately active. nullable
`endDateUtc` required	string (date-time)	When the announcement expires. Null means no expiration. Conditional: When StartDateUtc is not null and EndDateUtc is not null. Must be > . nullable
`isEnabled` required	boolean	Whether the announcement is enabled. Defaults to true.
`externalLinkUrl` required	string	Optional external link URL (e.g., "Learn more" link). Must be a valid HTTPS URL. Conditional: When ExternalLinkUrl is not empty. Conditional: When ExternalLinkUrl is not null. Max length: 2048. nullable
`externalLinkText` required	string	Optional external link display text. Conditional: When ExternalLinkText is not null. Max length: 256. Conditional: When ExternalLinkUrl is not empty. nullable
`targetAudience` required	all of AnnouncementTargetAudienceCreateOrUpdateDtoMergePatch	The target audience configuration for narrowing within scope.
`concurrencyStamp` required	string	Concurrency stamp for optimistic locking.

This request body has no documented fields.