Create an Announcement

POST /api/announcements deprecated

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

Create a new Announcement

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/announcements" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "",
  "body": "",
  "targetAudience": {}
}'

PowerShell

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

$body = @'
{
  "title": "",
  "body": "",
  "targetAudience": {}
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/announcements' `
    -Headers $headers -ContentType 'application/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.announcementsCreate({
  "title": "",
  "body": "",
  "targetAudience": {}
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/announcements', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "title": "",
    "body": "",
    "targetAudience": {}
  }),
});

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<CreateAnnouncementDto>("""
    {
      "title": "",
      "body": "",
      "targetAudience": {}
    }
    """);

var result = await api.AnnouncementsCreateAsync(body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/announcements");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "title": "",
      "body": "",
      "targetAudience": {}
    }
    """, 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.AnnouncementsApi(client)
    body = winkpg_api.CreateAnnouncementDto.from_dict({
      "title": "",
      "body": "",
      "targetAudience": {}
    })
    result = api.announcements_create(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "title": "",
  "body": "",
  "targetAudience": {}
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/announcements",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`title` required	string	The announcement title. nullablemin length 3max length 256
`body` required	string	The announcement body content (supports Markdown). nullablemin 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. Conditional: When StartDateUtc is not null. nullable
`endDateUtc` required	string (date-time)	When the announcement expires. Null means no expiration. Conditional: When EndDateUtc is not null. 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 AnnouncementTargetAudienceCreateOrUpdateDto	The target audience configuration for narrowing within scope.

This request body has no documented fields.