Update a workspace

PATCH

/v2/workspaces/:workspaceId

This endpoint updates the name of an existing workspace identified by its workspaceId.

Usage notes

Set NoDuplicates to true to prevent the creation of a duplicate workspace.
Retrieve the workspaceId by calling the /v2/workspaces endpoint.

Usage scenarios

Configuration change: Allows users to update workspace settings or names as projects evolve or requirements change.
Access control adjustments: Update workspace details in response to organizational changes or policy updates.

Best practices

Partial updates: Use PATCH to support partial updates, only sending the fields that need to be updated.
Validation: Validate input data to ensure it adheres to expected formats and constraints. Handle errors gracefully and inform the user of any constraints.

This endpoint updates the name of an existing workspace identified by its workspaceId. ### Usage notes - Set `NoDuplicates` to `true` to prevent the creation of a duplicate workspace. - Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint. ### Usage scenarios - **Configuration change**: Allows users to update workspace settings or names as projects evolve or requirements change. - **Access control adjustments**: Update workspace details in response to organizational changes or policy updates. ### Best practices - **Partial updates**: Use PATCH to support partial updates, only sending the fields that need to be updated. - **Validation**: Validate input data to ensure it adheres to expected formats and constraints. Handle errors gracefully and inform the user of any constraints.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workspaceIdstringRequired

Request

The request body.

namestringRequired

Name of the new workspace.

noDuplicatesbooleanOptional

Set to true to avoid creating a workspace with a duplicate name.

Response

The response body.

workspaceIdstring

workspaceUrlIdstring

Base62-encoded identifier used in Sigma workspace URLs.

namestring

createdBystring

updatedBystring

createdAtdatetime

updatedAtdatetime

$	curl -X PATCH https://api.sigmacomputing.com/v2/workspaces/workspaceId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Marketing Analytics Workspace"
>	}'

1	{
2	"workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3	"workspaceUrlId": "4f7G9kL2",
4	"name": "Marketing Analytics Workspace",
5	"createdBy": "jane.doe@company.com",
6	"updatedBy": "john.smith@company.com",
7	"createdAt": "2024-01-15T09:30:00Z",
8	"updatedAt": "2024-04-20T14:45:00Z"
9	}