Note: This developer site is moving to developers.google.com/tag-platform and will be redirected by September 30, 2021

Environments: update

Updates a GTM Environment. Try it now.

Request

HTTP request

PUT https://www.googleapis.com/tagmanager/v2/path

Parameters

Parameter name Value Description
Path parameters
path string GTM Environment's API relative path. Example: accounts/{account_id}/containers/{container_id}/environments/{environment_id}
Optional query parameters
fingerprint string When provided, this fingerprint must match the fingerprint of the environment in storage.

Authorization

This request requires authorization with the following scope:

Scope
https://www.googleapis.com/auth/tagmanager.edit.containers

For more information, see the authentication and authorization page.

Request body

In the request body, supply an Environments resource with the following properties:

Property name Value Description Notes
Required Properties
name string The environment display name. Can be set or changed only on USER type environments. writable
Optional Properties
description string The environment description. Can be set or changed only on USER type environments. writable
enableDebug boolean Whether or not to enable debug by default for the environment. writable
url string Default preview page url for the environment. writable

Response

If successful, this method returns an Environments resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.