SendMessage
Usage information for the operation SendMessage.rsb.
Workday Resource Information
Secured by: Administer Communications
Scope: System
Aggregate Fields
The connector represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
Recipients_Contacts_Aggregate
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
Input
| Name | Type | Description |
| CommID_Id | String | Unique identifier for the communication instance. |
| EmailDetail_Body | String | The main content of the email message. |
| EmailDetail_Name | String | Configuration name of the email used in the REST API. |
| EmailDetail_ReplyTo | String | The email address for replies to the message. |
| EmailDetail_Subject | String | The subject line of the email message. |
| MessageTemplate_Id | String | Unique identifier for the message template used. |
| NotificationType_Id | String | Unique identifier for the type of notification. |
| PushDetail_Id | String | Unique identifier for the push notification instance. |
| PushDetail_Message | String | The main content of the push notification message. |
| PushDetail_RedirectURL | String | URL to launch the mobile app upon message acknowledgment. |
| Recipients_Contacts_Aggregate | String | List of recipients for the message. |
| SenderOverride_Id | String | Unique identifier for the sender override. |
Result Set Columns
| Name | Type | Description |
| CommID_Descriptor | String | Description of the communication instance. |
| CommID_Href | String | URL link to the communication instance. |
| CommID_Id | String | Unique identifier for the communication instance. |
| EmailDetail_Body | String | The main content of the email message. |
| EmailDetail_Name | String | Configuration name of the email used in the REST API. |
| EmailDetail_ReplyTo | String | The email address for replies to the message. |
| EmailDetail_Subject | String | The subject line of the email message. |
| MessageTemplate_Descriptor | String | Description of the message template instance. |
| MessageTemplate_Href | String | URL link to the message template instance. |
| MessageTemplate_Id | String | Unique identifier for the message template used. |
| NotificationType_Descriptor | String | Description of the notification type instance. |
| NotificationType_Href | String | URL link to the notification type instance. |
| NotificationType_Id | String | Unique identifier for the type of notification. |
| PushDetail_Id | String | Unique identifier for the push notification instance. |
| PushDetail_Message | String | The main content of the push notification message. |
| PushDetail_RedirectURL | String | URL to launch the mobile app upon message acknowledgment. |
| Recipients_Contacts_Aggregate | String | List of recipients for the message. |
| SenderOverride_Descriptor | String | Description of the sender override instance. |
| SenderOverride_Href | String | URL link to the sender override instance. |
| SenderOverride_Id | String | Unique identifier for the sender override. |