Workspaces: create_version

Creates a Container Version from the entities present in the workspace, deletes the workspace, and sets the base container version to the newly created version. Try it now.


HTTP request



Parameter name Value Description
Path parameters
path string GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}


This request requires authorization with the following scope:


For more information, see the authentication and authorization page.

Request body

In the request body, supply data with the following structure:

  "name": string,
  "notes": string
Property name Value Description Notes
name string The name of the container version to be created.
notes string The notes of the container version to be created.


If successful, this method returns a response body with the following structure:

  "containerVersion": accounts.containers.versions Resource,
  "syncStatus": {
    "mergeConflict": boolean,
    "syncError": boolean
  "compilerError": boolean,
  "newWorkspacePath": string
Property name Value Description Notes
containerVersion nested object The container version created.
syncStatus nested object Whether version creation failed when syncing the workspace to the latest container version.
syncStatus.mergeConflict boolean Synchornization operation detected a merge conflict.
syncStatus.syncError boolean An error occurred during the synchronization operation.
compilerError boolean Compiler errors or not.
newWorkspacePath string Auto generated workspace path created as a result of version creation. This field should only be populated if the created version was not a quick preview.

Try it!

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