Home Guides Reference Support

Method: invitations.create

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to create invitations for this course or for access errors.
  • NOT_FOUND if the course or the user does not exist.
  • FAILED_PRECONDITION if the requested user's account is disabled or if the user already has this role or a role with greater permissions.
  • ALREADY_EXISTS if an invitation for the specified user and course already exists.

HTTP request

POST https://classroom.googleapis.com/v1/invitations

The URL uses gRPC Transcoding syntax.

Request body

The request body contains an instance of Invitation.

Response body

If successful, the response body contains a newly created instance of Invitation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/classroom.rosters

For more information, see the OAuth 2.0 Overview.

Try it!