---
title: "Update workspace state"
method: POST
path: "/v1/workspaces/update"
tags: ["workspace"]
---

# Update workspace state

`POST /v1/workspaces/update`

## Request body

- WorkspaceUpdate — Used to apply a patch-style update to a workspace, which means that null properties remain unchanged
  - `anonymousDataCollection` boolean
  - `defaultGeography` 'auto' | 'us' | 'eu'
  - `displaySetupWizard` boolean
  - `email` string, email
  - `initialSetupComplete` boolean
  - `news` boolean
  - `notifications` Notification[]
    - `customerioConfiguration` CustomerioNotificationConfiguration
    - `notificationType` 'slack' | 'customerio', required
    - `sendOnFailure` boolean, required
    - `sendOnSuccess` boolean, required
    - `slackConfiguration` SlackNotificationConfiguration
      - `webhook` string, required
  - `securityUpdates` boolean
  - `webhookConfigs` WebhookConfigWrite[]
    - `authToken` string — an auth token, to be passed as the value for an HTTP Authorization header.
    - `name` string — human readable name for this webhook e.g. for UI display.
    - `validationUrl` string — if supplied, the webhook config will be validated by checking that this URL returns a 2xx response.
  - `workspaceId` string, uuid, required

## Response `200`

Successful operation

- WorkspaceRead
  - `anonymousDataCollection` boolean
  - `customerId` string, uuid, required
  - `defaultGeography` 'auto' | 'us' | 'eu'
  - `displaySetupWizard` boolean
  - `email` string, email
  - `feedbackDone` boolean
  - `firstCompletedSync` boolean
  - `initialSetupComplete` boolean, required
  - `name` string, required
  - `news` boolean
  - `notifications` Notification[]
    - `customerioConfiguration` CustomerioNotificationConfiguration
    - `notificationType` 'slack' | 'customerio', required
    - `sendOnFailure` boolean, required
    - `sendOnSuccess` boolean, required
    - `slackConfiguration` SlackNotificationConfiguration
      - `webhook` string, required
  - `securityUpdates` boolean
  - `slug` string, required
  - `webhookConfigs` WebhookConfigRead[]
    - `id` string, uuid, required
    - `name` string — human-readable name e.g. for display in UI
  - `workspaceId` string, uuid, required

## Other responses

- `404` — Object with given id was not found.
- `422` — Input failed validation

---

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