---
title: "Set Workspace Display Name"
method: POST
path: "/api/set_workspace_display_name"
tags: ["Admin"]
---

# Set Workspace Display Name

`POST /api/set_workspace_display_name`

## Request

- Base URL: `https://app.getdot.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://app.getdot.ai/api/set_workspace_display_name`
- Auth: one of:
  - API key in header `X-API-KEY`
  - API key in cookie `Authorization`
  - OAuth 2 (password, token URL `/api/auth/token`)

Set or clear a workspace's mutable display name. The internal workspace_name
(and therefore org_id, file paths, user ids) is never affected.
Only organization admins or the specific workspace's admin can rename it.

## Request body

- BodySetWorkspaceDisplayNameApiSetWorkspaceDisplayNamePost
  - `workspace_name` string, required: Internal name of the workspace to rename
  - `display_name` string, nullable: New human-friendly display name; omit or blank to clear it

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getdot/apis/dot-api-2.md) · [All operations](https://skmtc.dev/getdot/apis/dot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/getdot/apis/dot-api-2/revisions/d26fe7163a7f?raw)