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 providedstudentId
is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by thestudentId
, if guardians are not enabled for the domain in question, or for other access errors.INVALID_ARGUMENT
if astudentId
is specified, but its format cannot be recognized (it is not an email address, nor astudentId
from the API).NOT_FOUND
if the requesting user is permitted to modify guardians for the requestedstudentId
, but noGuardian
record exists for that student with the providedguardianId
.
HTTP request
DELETE https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
studentId |
The student whose guardian is to be deleted. One of the following:
|
guardianId |
The |
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/classroom.guardianlinks.students
For more information, see the Authorization guide.