# PATCH /api/announcements/{id}

Partially update an Announcement

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.

**Operation ID:** `announcementsMergePatchUpdate`

## Authorization

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

Required permissions:
- `Announcements.Management`
- `Announcements.Management.Update`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

Required.

An RFC 7396 JSON Merge Patch. Send only the fields you want to change. 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 resource requires rejects null and fails validation rather than being cleared. The schema publishes every field that rejects null as not nullable.

**Content type:** `application/merge-patch+json`

Schema: `UpdateAnnouncementDtoMergePatch`

Properties:
- `title` (string): The announcement title.
- `body` (string): The announcement body content (supports Markdown).
- `scope` (object): The organizational scope of the announcement.
- `priority` (object): The priority level of the announcement.
- `displayOptions` (object): How the announcement should be displayed to users.
- `resellerId` (string(uuid)): The reseller ID for reseller-scoped announcements.  Required when Scope is Reseller. Required: When Scope == Reseller.
- `merchantId` (string(uuid)): The merchant ID for merchant-scoped announcements.  Required when Scope is Merchant. Required: When Scope == Merchant.
- `startDateUtc` (string(date-time)): When the announcement becomes active. Null means immediately active.
- `endDateUtc` (string(date-time)): When the announcement expires. Null means no expiration. Conditional: When StartDateUtc is not null and EndDateUtc is not null. Must be > .
- `isEnabled` (boolean): Whether the announcement is enabled. Defaults to true.
- `externalLinkUrl` (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.
- `externalLinkText` (string): Optional external link display text. Conditional: When ExternalLinkText is not null. Max length: 256. Conditional: When ExternalLinkUrl is not empty.
- `targetAudience` (object): The target audience configuration for narrowing within scope.
- `concurrencyStamp` (string): Concurrency stamp for optimistic locking.

```json
{
  "title": "new value"
}
```

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `AnnouncementDto`

Properties:
- `extraProperties` (object)
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity.
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified.
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity.
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted.
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted.
- `tenantId` (string(uuid)): The tenant this announcement belongs to. Null for host-level announcements.
- `concurrencyStamp` (string): Concurrency stamp for optimistic locking.
- `entityVersion` (integer(int32)): Entity version for optimistic concurrency.
- `title` (string): The announcement title.
- `body` (string): The announcement body content (supports Markdown).
- `scope` (object): The organizational scope of the announcement.
- `priority` (object): The priority level of the announcement.
- `displayOptions` (object): How the announcement should be displayed to users.
- `resellerId` (string(uuid)): The reseller ID for reseller-scoped announcements.
- `resellerPathPrefix` (string): The reseller path prefix for hierarchical matching.
- `merchantId` (string(uuid)): The merchant ID for merchant-scoped announcements.
- `startDateUtc` (string(date-time)): When the announcement becomes active.
- `endDateUtc` (string(date-time)): When the announcement expires.
- `isEnabled` (boolean): Whether the announcement is enabled.
- `externalLinkUrl` (string): Optional external link URL.
- `externalLinkText` (string): Optional external link display text.
- `createdByUserId` (string(uuid)): The user who created this announcement.
- `targetAudience` (object): The target audience configuration.
- `isActive` (boolean): Whether the announcement is currently active (within schedule and enabled).
- `targetedUserCount` (integer(int32)): Estimated number of targeted users (snapshot from create/update time).  Null if the count could not be computed.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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

```bash
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

```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
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
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)

```typescript
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();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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)

```csharp
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();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.