CreateAnnouncementTemplateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
DTO for creating an announcement template.
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 | ||||||
|---|---|---|---|---|---|---|---|---|
name
required |
string | Template name shown in the picker when selecting a template.
nullablemin length 0max 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.
| ||||||
title
required |
string | Default 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 | Default announcement body content.
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.
| ||||||
priority
required |
AnnouncementPriority AnnouncementPriority | Default priority level.
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 | Default display options.
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 default external link URL.
Conditional: When ExternalLinkUrl is not empty.
Conditional: When ExternalLinkUrl is not null. Max length: 2048.
nullablemin length 0max length 2048
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 default external link display text.
Conditional: When ExternalLinkText is not null. Max length: 256.
Conditional: When ExternalLinkUrl is not empty.
nullablemin length 0max 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.
|
This model has no documented fields.