---
title: "Update Workspace"
method: PATCH
path: "/v1/workspaces/{workspace_id}"
tags: ["workspaces"]
---

# Update Workspace

`PATCH /v1/workspaces/{workspace_id}`

Update a workspace's name and/or contact details (admin only).

## Path parameters

- `workspace_id` string, uuid, required

## Request body

- WorkspaceUpdate — Partial update: only fields the client sends are applied. contact_email/contact_phone accept null (or empty string) to clear the stored value — "not sent" and "sent as null" are distinguished via model_fields_set.
  - `name` string, nullable
  - `contact_email` string, nullable
  - `contact_phone` string, nullable

## Response `200`

Successful Response

- WorkspaceOut
  - `id` string, uuid, required
  - `name` string, required
  - `parent_workspace_id` string, uuid, nullable
  - `role` string, nullable
  - `clerk_org_id` string, nullable
  - `organization_image_url` string, nullable
  - `company_domain` string, nullable
  - `contact_email` string, nullable
  - `contact_phone` string, nullable
  - `setup_completed_at` string, date-time, nullable
  - `setup_skipped_at` string, date-time, nullable
  - `setup_status` string
  - `setup_steps` WorkspaceSetupStepOut[]
    - `id` string, required
    - `label` string, required
    - `description` string, required
    - `status` string, required
    - `completed_at` string, date-time, nullable
    - `unavailable_reason` string, nullable
  - `created_at` string, date-time, nullable

## Other responses

- `422` — Validation Error

---

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