Method: projects.deployments.update

  • This endpoint updates a specific deployment of an Apps Script project using an HTTP PUT request.

  • You will need to provide the script project's Drive ID and the deployment ID as path parameters.

  • The request body should contain details like the version number, manifest file name, and description of the deployment.

  • A successful response returns a Deployment object representing the updated deployment.

  • To authorize this request, you must have the https://www.googleapis.com/auth/script.deployments OAuth scope.

Updates a deployment of an Apps Script project.

HTTP request

PUT https://script.googleapis.com/v1/projects/{deploymentConfig.scriptId}/deployments/{deploymentId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
deploymentConfig.scriptId

string

The script project's Drive ID.

deploymentId

string

The deployment ID for this deployment.

Request body

The request body contains data with the following structure:

JSON representation
{
  "deploymentConfig": {
    "scriptId": string,
    "versionNumber": integer,
    "manifestFileName": string,
    "description": string
  }
}
Fields
deploymentConfig.versionNumber

integer

The version number on which this deployment is based.

deploymentConfig.manifestFileName

string

The manifest file name for this deployment.

deploymentConfig.description

string

The description for this deployment.

Response body

If successful, the response body contains an instance of Deployment.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/script.deployments

For more information, see the OAuth 2.0 Overview.