Google Classroom add-ons are now generally available to developers! Please see the add-ons documentation for more information.

Method: courses.aliases.delete

Deletes an alias of a course.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to remove the alias or for access errors.
  • NOT_FOUND if the alias does not exist.
  • FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).

HTTP request

DELETE https://classroom.googleapis.com/v1/courses/{courseId}/aliases/{alias}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
courseId

string

Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias .
alias

string

Alias to delete. This may not be the Classroom-assigned identifier.

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/classroom.courses

For more information, see the Authorization guide.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年04月17日 UTC.