| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The PlanCare2 id of the message. |
integer |
- |
| From |
The sender of the message. Must correspond with the logged in user. |
MessageAddress |
Required |
| To |
The addresses the message is sent to. |
Collection of MessageAddress |
Required |
| Cc |
Addresses that should receive a carbon copy of the message. |
Collection of MessageAddress |
- |
| Subject |
The subject of the message. |
string |
Required |
| Body |
The message body. |
string |
- |
| SentDate |
The time the message has been sent. |
date |
Nullable |
| RequestReadConformation |
Set when the recipients should send a received conformation. |
boolean |
Required Deprecated (unavailable from 21.01.1P): Please use 'RequestReadConfirmation' instead. |
| RequestReadConfirmation |
Set when the recipients should send a received confirmation. |
boolean |
Required |
| ClientId |
Optional: The Identity of the Client involved |
Identity |
- |
| Type |
The type of the message. |
MessageType |
- |
| RelatedMessageId |
Internal id of the related message. |
integer |
Nullable |
| CalendarPlannedItemId |
The PlanCare2 id of the appointment the message is related to. |
integer |
Nullable |
| RecurrenceText |
Description of the recurrence of the appointment. Empty when the appointment is not recurring. |
string |
- |
| IsRead |
Is the message marked as 'read' by the currently logged on user. |
boolean |
- |