- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Modifies a guardian invitation.
Currently, the only valid modification is to change the
COMPLETE. This has the effect of withdrawing the invitation.
This method returns the following error codes:
PERMISSION_DENIEDif the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors.
FAILED_PRECONDITIONif the guardian link is not in the
INVALID_ARGUMENTif the format of the student ID provided cannot be recognized (it is not an email address, nor a
userIdfrom this API), or if the passed
COMPLETE, or if it modifies fields other than
NOT_FOUNDif the student ID provided is a valid student ID, but Classroom has no record of that student, or if the
idfield does not refer to a guardian invitation known to Classroom.
The URL uses Google API HTTP annotation syntax.
The ID of the student whose guardian invitation is to be modified.
Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid:
When set in a query parameter, this field should be specified as
A comma-separated list of fully qualified names of fields. Example:
The request body contains an instance of
If successful, the response body contains an instance of
Requires the following OAuth scope:
For more information, see the OAuth 2.0 Overview.