---
title: "Update a workspace"
method: PATCH
path: "/workspaces/{workspaceId}"
tags: ["public_workspaces", "public", "Workspaces"]
---

# Update a workspace

`PATCH /workspaces/{workspaceId}`

## Request body

- WorkspaceUpdateRequest
  - `name` string — Name of the workspace
  - `notifications` NotificationsConfig — Configures workspace notifications.
    - `failure` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `success` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `connectionUpdate` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `connectionUpdateActionRequired` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `syncDisabled` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `syncDisabledWarning` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
  - `regionId` string, uuid

## Response `200`

Successful operation

- WorkspaceResponse — Provides details of a single workspace.
  - `workspaceId` string, UUID, required
  - `name` string, required
  - `dataResidency` string, required
  - `notifications` NotificationsConfig, required — Configures workspace notifications.
    - `failure` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `success` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `connectionUpdate` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `connectionUpdateActionRequired` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `syncDisabled` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string
    - `syncDisabledWarning` NotificationConfig — Configures a notification.
      - `email` EmailNotificationConfig — Configures an email notification.
        - `enabled` boolean
      - `webhook` WebhookNotificationConfig — Configures a webhook notification.
        - `enabled` boolean
        - `url` string

## Other responses

- `400` — Invalid data
- `403` — Not allowed

## Changes

> 31 revisions in range; 1 could not be searched.

- **2025-04-07** `db1eb8ad2e38` — 1 info
  - added the new optional request property `regionId`
- **2025-03-27** `eb889125bd9d` — 4 info
  - the `dataResidency` response's property default value `auto` was removed for the status `200`
  - removed the `auto` enum value from the `dataResidency` response property for the response status `200`
  - removed the `eu` enum value from the `dataResidency` response property for the response status `200`
  - removed the `us` enum value from the `dataResidency` response property for the response status `200`
- **2025-02-11** `6003f9d50fce` — 3 info
  - added the new optional request property `notifications`
  - the request property `name` became optional
  - added the required property `notifications` to the response with the `200` status

[Change history](https://skmtc.dev/airbytehq/apis/airbyte-api/changes/workspaces/:workspaceId/patch.md)

---

[API](https://skmtc.dev/airbytehq/apis/airbyte-api.md) · [All operations](https://skmtc.dev/airbytehq/apis/airbyte-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/airbytehq/airbyte-api/revisions/1ab9ff46c57a/schema)