Represents a request sent through API to command a Push notification (either Email or SMS) to one or more recipients
This is how to push a notification.
PushNotificationRequest
| Field | Type | Inherited from | Description |
|---|---|---|---|
| AttachedImage | ObjectLinkItem | PushNotificationRequest | If Set and delivery type is Email attach the image to the email |
| EventRecipientKeys | String[] | PushNotificationRequest | Gets or sets the event recipient keys. |
| Message | String | PushNotificationRequest | Gets or sets the message. |
| MessageTemplateKey | String | PushNotificationRequest | Gets or sets the message template key. |
| Metadata | MetadataItem | PushNotificationRequest | Additional meta data that will be made available to the message template |
| ObjectLinks | ObjectLinkItem[] | PushNotificationRequest | Additional Ojbects that will be made available to the message template |
| PushNotificationType | PushNotificationTypes | PushNotificationRequest | Gets or sets the type of push notification to send (e.g., email, SMS, mobile app notification). |
| RecipientKeys | String[] | PushNotificationRequest | Gets or sets the recipient keys. |
| Subject | String | PushNotificationRequest | Gets or sets the subject line for the push notification (typically used for email notifications). |
{
"AttachedImage" : "[ObjectLinkItem](/object-model/objectlinkitem)",
"EventRecipientKeys" : "String[]",
"Message" : "String",
"MessageTemplateKey" : "String",
"Metadata" : "[MetadataItem](/object-model/metadataitem)",
"ObjectLinks" : "[ObjectLinkItem](/object-model/objectlinkitem)[]",
"PushNotificationType" : "[PushNotificationTypes](/object-model/pushnotificationtypes)",
"RecipientKeys" : "String[]",
"Subject" : "String"
}
Example in C#
// Returns: nothing
await client.PushNotificationAsync(FolderInfo folder, PushNotificationRequest request);