Method: userProfiles.guardianInvitations.patch
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Modifica um convite de responsável.
No momento, a única modificação válida é mudar o state de PENDING para COMPLETE. Isso tem o efeito de cancelar o convite.
Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED se o usuário atual não tiver permissão para gerenciar tutores, se os tutores não estiverem ativados para o domínio em questão ou por outros erros de acesso.FAILED_PRECONDITION se a vinculação do responsável não estiver no estado PENDING.INVALID_ARGUMENT se o formato do ID do estudante fornecido não puder ser reconhecido (não é um endereço de e-mail nem um userId desta API) ou se o GuardianInvitation transmitido tiver um state diferente de COMPLETE ou se ele modificar campos diferentes de state.NOT_FOUND se o documento de identificação do estudante fornecido for válido, mas o Google Sala de Aula não tiver registro desse estudante ou se o campo id não se referir a um convite de responsável conhecido do Google Sala de Aula.
Solicitação HTTP
PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
studentId |
string
O documento de identificação do estudante cujo convite para o responsável será modificado.
|
invitationId |
string
O campo id do GuardianInvitation a ser modificado.
|
Parâmetros de consulta
| Parâmetros |
updateMask |
string (FieldMask format)
Máscara que identifica quais campos do curso serão atualizados. Este campo é obrigatório para fazer uma atualização. A atualização falha se campos inválidos forem especificados. Os seguintes campos são válidos:
Quando definido em um parâmetro de consulta, esse campo precisa ser especificado como updateMask=<field1>,<field2>,...
É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
|
Corpo da solicitação
O corpo da solicitação contém uma instância de GuardianInvitation.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de GuardianInvitation.
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# Method: userProfiles.guardianInvitations.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nModifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n- `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](/workspace/classroom/reference/Access.Errors).\n- `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n- `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`.\n- `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.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|-----------------------------------------------------------------------------|\n| `studentId` | `string` The ID of the student whose guardian invitation is to be modified. |\n| `invitationId` | `string` The `id` field of the `GuardianInvitation` to be modified. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: - `state` When set in a query parameter, this field should be specified as `updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Response body\n\nIf successful, the response body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
