Delete

Deletes a guardian

2 variables
0 variables

Deletes a guardian.

The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API.

This method returns the following error codes:

  • PERMISSION_DENIED if no user that matches the provided student_id is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors.
  • INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API).
  • NOT_FOUND if the requesting user is permitted to modify guardians for the requested student_id, but no Guardian record exists for that student with the provided guardian_id

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 2 input parameters

  = Parameter name
  = Format

studentId STRING Required

The student whose guardian is to be deleted. One of the following:

  • the numeric identifier for the user
  • the email address of the user
  • the string literal "me", indicating the requesting user

guardianId STRING Required

The id field from a Guardian