Patch

Modifies a guardian invitation

8 variables
5 variables

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

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage guardians for students in your Google Classroom classes

Input

This building block consumes 8 input parameters

  = Parameter name
  = Format

studentId STRING Required

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

invitationId STRING Required

The id field of the GuardianInvitation to be modified

updateMask ANY

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

creationTime ANY

The time that this invitation was created.

Read-only

invitationId STRING

Unique identifier for this invitation.

Read-only

studentId STRING

ID of the student (in standard format)

state ENUMERATION

The state that this invitation is in

invitedEmailAddress STRING

Email address that the invitation was sent to. This field is only visible to domain administrators

Output

This building block provides 5 output parameters

  = Parameter name
  = Format

creationTime ANY

The time that this invitation was created.

Read-only

invitationId STRING

Unique identifier for this invitation.

Read-only

studentId STRING

ID of the student (in standard format)

state ENUMERATION

The state that this invitation is in

invitedEmailAddress STRING

Email address that the invitation was sent to. This field is only visible to domain administrators