Modifies a guardian invitation

Source: R/classroom_functions.R

Currently, the only valid modification is to change the state fromPENDING to COMPLETE. This has the effect of withdrawing the invitation.

gc_user_profiles_guardian_invitations_patch(
  GuardianInvitation,
  studentId,
  invitationId,
  updateMask = NULL
)

Arguments

GuardianInvitation

The gc_guardian_invitation object to pass to this method
studentId

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

The id field of the GuardianInvitation to be modified
updateMask

Mask that identifies which fields on the course to update

Details

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 user_id 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.

Authentication scopes used by this function are:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Set options(googleAuthR.scopes.selected = c("https://www.googleapis.com/auth/classroom.guardianlinks.students") Then run googleAuthR::gar_auth() to authenticate. See gar_auth for details.

See also

Google Documentation

Other GuardianInvitation functions: gc_guardian_invitation(), gc_user_profiles_guardian_invitations_create()