Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.
Once the guardian accepts the invitation, their
state will change to
COMPLETED and they will start receiving guardian notifications. A
Guardian resource will also be created to represent the active guardian.
The request object must have the
invitedEmailAddress fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.
This method returns the following error codes:
PERMISSION_DENIEDif the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors.
RESOURCE_EXHAUSTEDif the student or guardian has exceeded the guardian link limit.
INVALID_ARGUMENTif the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a
userIdfrom this API). This error will also be returned if read-only fields are set, or if the
statefield is set to to a value other than
NOT_FOUNDif the student ID provided is a valid student ID, but Classroom has no record of that student.
ALREADY_EXISTSif there is already a pending guardian invitation for the student and
invitedEmailAddressprovided, or if the provided
invitedEmailAddressmatches the Google account of an existing
Guardianfor this user.
The URL uses Google API HTTP annotation syntax.
ID of the student (in standard format)
The request body contains an instance of
If successful, the response body contains a newly created instance of
Requires the following OAuth scope:
For more information, see the OAuth 2.0 Overview.