- 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 state
from PENDING
to COMPLETE
. This has the effect of withdrawing the invitation.
This method returns the following error codes:
PERMISSION_DENIED
if 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_PRECONDITION
if the guardian link is not in thePENDING
state.INVALID_ARGUMENT
if the format of the student ID provided cannot be recognized (it is not an email address, nor auserId
from this API), or if the passedGuardianInvitation
has astate
other thanCOMPLETE
, or if it modifies fields other thanstate
.NOT_FOUND
if the student ID provided is a valid student ID, but Classroom has no record of that student, or if theid
field does not refer to a guardian invitation known to Classroom.
HTTP request
PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
studentId |
The ID of the student whose guardian invitation is to be modified. |
invitationId |
The |
Query parameters
Parameters | |
---|---|
updateMask |
Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid:
When set in a query parameter, this field should be specified as
This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body contains an instance of GuardianInvitation
.
Response body
If successful, the response body contains an instance of GuardianInvitation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/classroom.guardianlinks.students
For more information, see the Authorization guide.