An Invitation resource in Classroom represents an invitation for a user to join a course with a specific course role.
Each Invitation resource contains the following fields:
id
of the invitation that is assigned by Classroom.userId
of the user that the invitation is sent to.courseId
of the course the user is being invited to.role
the course role that the invited user will have in the course.
Create an Invitation
Create an invitation so that a user can join a course with the specified role by
calling the invitations.create()
method. Include the Invitation resource
in the request body and specify the courseId
, userId
, and role
.
Java
Retrieve an Invitation
Retrieve a specific invitation by calling the invitations.get()
method
and specifying the id
of the invitation.
Java
Accept an Invitation
Accepting an invitation to a course deletes the invitation and adds the user to
the course with the role specified in the invitation. Accept an invitation by
calling the invitations.accept()
method and specifying the id
of the
invitation.
Java
Delete an Invitation
The only way to update an invitation is to delete it and create a new
invitation. To delete the invitation, call the invitations.delete()
method
and specify the id
.