Delete
|
|||||
|
|
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 providedstudent_id
is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by thestudent_id
, if guardians are not enabled for the domain in question, or for other access errors.INVALID_ARGUMENT
if astudent_id
is specified, but its format cannot be recognized (it is not an email address, nor astudent_id
from the API).NOT_FOUND
if the requesting user is permitted to modify guardians for the requestedstudent_id
, but noGuardian
record exists for that student with the providedguardian_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
Name | Format | Description |
---|---|---|
studentId Required |
STRING |
The student whose guardian is to be deleted. One of the following:
|
guardianId Required |
STRING |
The |
= Parameter name
= Format
studentId STRING Required The student whose guardian is to be deleted. One of the following:
|
guardianId STRING Required The |