Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
REST Resource: invitations
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Invitation
An invitation to join a course.
| JSON representation |
{
"id": string,
"userId": string,
"courseId": string,
"role": enum (CourseRole)
} |
| Fields |
id |
string
Identifier assigned by Classroom. Read-only.
|
userId |
string
Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following:
- the numeric identifier for the user
- the email address of the user
- the string literal
"me", indicating the requesting user
|
courseId |
string
Identifier of the course to invite the user to.
|
role |
enum (CourseRole)
Role to invite the user to have. Must not be COURSE_ROLE_UNSPECIFIED.
|
CourseRole
Possible roles a user may be invite to have.
| Enums |
COURSE_ROLE_UNSPECIFIED |
No course role. |
STUDENT |
Student in the course. |
TEACHER |
Teacher of the course. |
OWNER |
Owner of the course. |
Methods |
|
|
Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. |
|
|
Creates an invitation. |
|
|
Deletes an invitation. |
|
|
Returns an invitation. |
|
|
Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
[null,null,["Last updated 2025-04-17 UTC."],[],[],null,["# REST Resource: invitations\n\n- [Resource: Invitation](#Invitation)\n - [JSON representation](#Invitation.SCHEMA_REPRESENTATION)\n- [CourseRole](#CourseRole)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Invitation\n--------------------\n\nAn invitation to join a course.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"userId\": string, \"courseId\": string, \"role\": enum (/workspace/classroom/reference/rest/v1/invitations#CourseRole) } ``` |\n\n| Fields ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier assigned by Classroom. Read-only. |\n| `userId` | `string` Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `courseId` | `string` Identifier of the course to invite the user to. |\n| `role` | `enum (`[CourseRole](/workspace/classroom/reference/rest/v1/invitations#CourseRole)`)` Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. |\n\nCourseRole\n----------\n\nPossible roles a user may be invite to have.\n\n| Enums ||\n|---------------------------|------------------------|\n| `COURSE_ROLE_UNSPECIFIED` | No course role. |\n| `STUDENT` | Student in the course. |\n| `TEACHER` | Teacher of the course. |\n| `OWNER` | Owner of the course. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| ### [accept](/workspace/classroom/reference/rest/v1/invitations/accept) | Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. |\n| ### [create](/workspace/classroom/reference/rest/v1/invitations/create) | Creates an invitation. |\n| ### [delete](/workspace/classroom/reference/rest/v1/invitations/delete) | Deletes an invitation. |\n| ### [get](/workspace/classroom/reference/rest/v1/invitations/get) | Returns an invitation. |\n| ### [list](/workspace/classroom/reference/rest/v1/invitations/list) | Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. |"]]
