Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1310484273.7 KB
courses

Creates an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist. * FAILED_PRECONDITION for the following request error: * AttachmentNotVisible

post/v1/courses/{courseId}/announcements

Path parameters

courseIdstring required

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Request body

alternateLinkstring

Absolute link to this announcement in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only.

idstring

Classroom-assigned identifier of this announcement, unique per course. Read-only.

updateTimestring google-datetime

Timestamp of the most recent change to this announcement. Read-only.

courseIdstring

Identifier of the course. Read-only.

creationTimestring google-datetime

Timestamp when this announcement was created. Read-only.

state'ANNOUNCEMENT_STATE_UNSPECIFIED' | 'PUBLISHED' | 'DRAFT' | 'DELETED'

Status of this announcement. If unspecified, the default state is DRAFT.

scheduledTimestring google-datetime

Optional timestamp when this announcement is scheduled to be published.

assigneeMode'ASSIGNEE_MODE_UNSPECIFIED' | 'ALL_STUDENTS' | 'INDIVIDUAL_STUDENTS'

Assignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS.

textstring

Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.

creatorUserIdstring

Identifier for the user that created the announcement. Read-only.

Response

Successful response