Method: userProfiles.guardianInvitations.patch

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 the PENDING state.
  • INVALID_ARGUMENT if the format of the student ID provided cannot be recognized (it is not an email address, nor a userId from this API), or if the passed GuardianInvitation has a state other than COMPLETE, or if it modifies fields other than state.
  • NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the id 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 Google API HTTP annotation syntax.

Path parameters

Parameters
studentId

string

The ID of the student whose guardian invitation is to be modified.

invitationId

string

The id field of the GuardianInvitation to be modified.

Query parameters

Parameters
updateMask

string (FieldMask format)

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:

  • state

When set in a query parameter, this field should be specified as

updateMask=<field1>,<field2>,...

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

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 OAuth 2.0 Overview.

Try it!

Send feedback about...

Classroom API
Classroom API
Need help? Visit our support page.