---
title: "Update workspace data"
method: PATCH
path: "/api/v1/workspaces"
tags: ["workspace"]
---

# Update workspace data

`PATCH /api/v1/workspaces`

Update the current workspace's metadata.

    You can update:
    - Workspace name
    - Workspace picture

    **Use cases:**
    - Renaming workspaces
    - Updating branding or workspace avatars
    - Managing workspace settings in admin panels

## Request body

- object
  - `name` string
  - `picture` string, uri

## Response `200`

This response returns the updated data for the workspace.

- object — This response returns the updated data for the workspace.
  - `id` string, required
  - `users` string[], required
  - `roles` object, required
  - `name` string, required
  - `created` string, date-time, required
  - `picture` string, uri, required
  - `subscriptionStatus` 'payment_failed' | 'active' | 'canceled' | 'trialing' | 'overdue', required
  - `creator` string, required
  - `updater` string, required
  - `apiVersion` string
  - `willCancelAt` string, date-time, required
  - `blockedUsers` string[]
  - `type` unknown
  - `preferences` object
    - `disableAi` boolean
    - `enableAutoSceneNaming` boolean
    - `disableEmailEditing` boolean
    - `disableSceneSharing` boolean
    - `userApiKeysEnabled` boolean
  - `flags` number
  - `isDeleted` boolean
  - `deletedAt` number

## Other responses

- `400` — This response indicates that the request was malformed or contained invalid parameters.
- `401` — This response indicates that the client must authenticate to access the requested resource.
- `403` — This response indicates that the client does not have permission to access the requested resource.

---

[API](https://skmtc.net/excalidraw/apis/excalidraw-api.md) · [All operations](https://skmtc.net/excalidraw/apis/excalidraw-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/excalidraw/excalidraw-api/revisions/c1404d1545ba/schema)