Message and URL
The message field is required, referenced_url and referenced_description are optional. If a url & description are provided we'll display the link to the right of the message as a clickable link.
Start and End Timestamps
message_start and message_end are required fields. The broadcast message will display beginning at the message_start time and stop displaying at the message_end time. If a user sees the message and dismisses it, it will also stop displaying for that user.
Targeting Users/Practices
You can specify which users or practices to target by specifying them in target_practices, or target_users. Both fields are optional. If a practice's id is specified in target_practices the message will be displayed to the entire practice. If a user's id is specified in target_users the message will be displayed to that specific user.
If neither field is provided or both are provided blank, the message will be targeted at all practices that your API account is authorized to address. This is a way you can send messages to your entire enterprise without needing to specify individual practices.