---
title: "POST /v1/userProfiles/{studentId}/guardianInvitations"
method: POST
path: "/v1/userProfiles/{studentId}/guardianInvitations"
tags: ["userProfiles"]
---

# POST /v1/userProfiles/{studentId}/guardianInvitations

`POST /v1/userProfiles/{studentId}/guardianInvitations`

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.

## Path parameters

- `studentId` string, required

## Request body

- GuardianInvitation — An invitation to become the guardian of a specified user, sent to a specified email address.
  - `invitationId` string — Unique identifier for this invitation. Read-only.
  - `studentId` string — ID of the student (in standard format)
  - `state` 'GUARDIAN_INVITATION_STATE_UNSPECIFIED' | 'PENDING' | 'COMPLETE' — 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.
  - `creationTime` string, google-datetime — The time that this invitation was created. Read-only.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/classroom.md) · [All operations](https://skmtc.net/google/apis/classroom/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/classroom/revisions/1b98f151d40b/schema)
