Update a workspace

OpenAPI contract

Method

PATCH

Path

/api/v1/workspaces/{id}

Security

jwtBearer (bearer)

Response status

200 400 401 403 404 409 429 500

Request and response schemas

JSON

{
  "requestBody": {
    "application/json": {
      "$ref": "#/components/schemas/UpdateWorkspaceRequest"
    }
  },
  "responses": {
    "200": {
      "description": "Workspace updated",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/WorkspaceResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Requested workspace resource was not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "409": {
      "description": "Request conflicts with current workspace state",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

PATCH /api/v1/workspaces/{id} is JWT-only and requires workspace:manage. Send a nonblank name of at most 100 characters. The service trims the name and returns the updated workspace response.

A different workspace in the same organization cannot already use that name, ignoring case. A duplicate returns a conflict; an inaccessible workspace is not exposed. This operation renames only the workspace and does not move it to another organization.

json

{"name":"Production releases"}