For Developers

Announcements Overview

Announcements are content items teachers can use to share information or materials with students in a course. For example, an announcement could notify users about an upcoming quiz or remind them to bring materials to class. Announcements are grouped by class. If you're looking for materials to be grouped by modules, please see the Modules API and Pages API instead.

Additional Notes

  • Currently, this is a read-only API for Google Classroom integrations. Announcements must be created using the Google Classroom interface.

Properties

PropertyTypeDescription
idstringThe UUID for the announcement.
created_dateDateWhen the announcement was created in the data source.
updated_dateDateWhen the announcement was last updated in the data source.
propertiesobjectNon-standard properties that may be of interest to the developer.
titlestringThe title of the announcement.
bodystringThe body of the announcement. This will be used for LMS systems that support special formatting.
attachmentsAttachment[]The attachments associated with the announcement.
display_dateDateThe time at which the announcement becomes visible.
stateAnnouncementStateThe state of the announcement.
section_idsstring[]The UUIDs of the associated Sections.
category_idstringThe UUID of the associated Category.
start_dateDateThe time at which the announcement becomes visible.
end_dateDateThe time at which the announcement is no longer visible.

Supported Providers

ProviderSupport