CreateAnnouncementDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Data transfer object for creating a new announcement.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
title
required |
string | The announcement title.
nullablemin length 3max length 256
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
body
required |
string | The announcement body content (supports Markdown).
nullablemin length 10max length 8192
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
scope
required |
AnnouncementScope AnnouncementScope | The organizational scope of the announcement.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
priority
required |
AnnouncementPriority AnnouncementPriority | The priority level of the announcement.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
displayOptions
required |
AnnouncementDisplayOptions AnnouncementDisplayOptions | How the announcement should be displayed to users.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
resellerId
required |
string (uuid) | The reseller ID for reseller-scoped announcements.
Required when Scope is Reseller.
Required: When Scope == Reseller.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
merchantId
required |
string (uuid) | The merchant ID for merchant-scoped announcements.
Required when Scope is Merchant.
Required: When Scope == Merchant.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
startDateUtc
required |
string (date-time) | When the announcement becomes active. Null means immediately active.
Conditional: When StartDateUtc is not null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
isEnabled
required |
boolean | Whether the announcement is enabled. Defaults to true.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
externalLinkText
required |
string | Optional external link display text.
Conditional: When ExternalLinkText is not null. Max length: 256.
Conditional: When ExternalLinkUrl is not empty.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
targetAudience
required |
AnnouncementTargetAudienceCreateOrUpdateDto AnnouncementTargetAudienceCreateOrUpdateDto | The target audience configuration for narrowing within scope.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
Fields of AnnouncementTargetAudienceCreateOrUpdateDto:
This body has no documented fields. | ||||||||||||||||||||
This model has no documented fields.