| Name | Description | Type | Additional information |
|---|---|---|---|
| SenderName |
The name of the sender (can be site or a school name or custromized by admin) to assign as the thread's name |
string |
None. |
| SenderHierarchyId |
Id of sender's hierarchy |
integer |
None. |
| CourseIds |
CourseIds to send instant message to. |
Collection of integer |
None. |
| ProjectIds |
ProjectIds to send instant message to. |
Collection of integer |
None. |
| HierarchyIds |
HierarchyIds to send instant message to. |
Collection of integer |
None. |
| RecipientRoles |
The list of roles in specified hierarchies to send instant message to. |
Collection of Itslearning.RestApi.Entities.InstantMessageRecipientRole |
None. |
| ProfileIds |
The list of person profile ids to send instant message to. |
Collection of integer |
None. |
| FileIds |
Guids of files already uploaded to temporary file repo storage |
Collection of string |
None. |
| ToPersonIds |
PersonIds to send instant message to. A new thread will be created if the persons don't have an existing thread already. The ToPersonIds or the InstantMessageThreadId or CourseIds or ProjectIds need to have a valid value. |
Collection of integer |
None. |
| InstantMessageThreadId |
The thread to send to, if this is null or zero we will assume it's a new thread. |
integer |
None. |
| Text |
The text of the message |
string |
None. |
| SendAsIndividualMessages |
Gets whether a message to multiple recipients should be sent as individual messages |
boolean |
None. |