An array of recipient ids. These may be user ids or course/group ids prefixed with “course_” or “group_” respectively, e.g. recipients[]=1&recipients=2&recipients[]=course_3. If the course/group has over 100 enrollments, 'bulk_message' and 'group_conversation' must be set to true.

The subject of the conversation. This is ignored when reusing a conversation. Maximum length is 255 characters.

The message to be sent

Forces a new message to be created, even if there is an existing private conversation.

Defaults to false. When false, individual private conversations will be created with each recipient. If true, this will be a group conversation (i.e. all recipients may see all messages and replies). Must be set true if the number of recipients is over the set maximum (default is 100).

An array of attachments ids. These must be files that have been previously uploaded to the sender's “conversation attachments” folder.

Media comment id of an audio or video file to be associated with this message.

Allowed values: audio, video

Will add a faculty journal entry for each recipient as long as the user making the api call has permission, the recipient is a student and faculty journals are enabled in the account.

Allowed values: sync, async

Allowed values: unread, starred, archived

Used when generating “visible” in the API response. See the explanation under the index API action

Allowed values: and, or, default or

The course or group that is the context for this conversation. Same format as courses or groups in the recipients argument.