> ## Documentation Index > Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a workspace > Updates the specified workspace by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Only workspace owners and admins can perform this action. ## OpenAPI ````yaml /api/en/workspaces.yaml patch /workspaces/{workspaceId} openapi: 3.0.3 info: title: Altostrat Workspaces API version: 1.0.0 description: >- The Altostrat Workspaces API is the microservice responsible for tenancy, billing, user identity, and organizational hierarchy. It serves as the foundational layer for all multi-tenancy and subscription logic within the Altostrat SDX platform, enabling the secure separation of customer data and resources for SD-WAN, network automation, and agentic AI features. This API allows you to programmatically manage: - **Workspaces:** The top-level containers for all tenant resources, users, and billing configurations. - **Organizations:** Hierarchical entities used to model customer tenants or business units, track resource usage, and apply limits. - **Billing & Subscriptions:** The financial accounts and Stripe-powered subscriptions that govern access to Altostrat SDX features and resources. - **Members & Access:** The users and their specific roles (Owner, Admin, Viewer) within a workspace. Developers use this API to build the structural foundation and manage the billing lifecycle upon which all other Altostrat SDX automation and AI features operate. servers: - url: https://v1.api.altostrat.io description: Production API Server security: - bearerAuth: [] tags: - name: Workspaces description: Manage workspaces, the top-level containers for all resources. - name: Workspace Members description: Manage user access and roles within a workspace. - name: Organizations description: Manage hierarchical organizations for tenancy and resource segmentation. - name: Billing Accounts description: Manage financial accounts linked to Stripe for billing and subscriptions. - name: Subscriptions description: Manage product subscriptions powered by Stripe. - name: Invoices description: Retrieve invoice history and preview upcoming billing changes. - name: Payment Methods description: Manage customer payment methods for subscriptions. - name: Public description: Unauthenticated endpoints for retrieving public organization information. paths: /workspaces/{workspaceId}: patch: tags: - Workspaces summary: Update a workspace description: >- Updates the specified workspace by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Only workspace owners and admins can perform this action. parameters: - $ref: '#/components/parameters/WorkspaceId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceRequest' responses: '200': description: The updated workspace object. content: application/json: schema: $ref: '#/components/schemas/Workspace' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' components: parameters: WorkspaceId: name: workspaceId in: path required: true description: The ID of the workspace. schema: type: string example: ws_a1b2c3d4e5f6g7h8 schemas: UpdateWorkspaceRequest: type: object properties: name: type: string description: The new name for the workspace. Maximum 50 characters. example: ACME Corp. Workspace description: type: string nullable: true description: The new description for the workspace. Maximum 200 characters. example: Main workspace for all company operations. Workspace: type: object properties: id: type: string description: Unique identifier for the workspace, prefixed with `ws_`. example: ws_a1b2c3d4e5f6g7h8 name: type: string description: The name of the workspace. example: ACME Corporation description: type: string nullable: true description: An optional description for the workspace. example: Primary workspace for all ACME projects. billing_mode: type: string description: >- The billing mode for the workspace. Determines how subscriptions and usage are handled. enum: - single - assigned - pooled example: pooled pooled_seat_limit: type: integer nullable: true description: >- The total number of seats available in 'pooled' billing mode. This is null for other modes. example: 100 archived: type: boolean description: Whether the workspace is archived. example: false created_at: type: string format: date-time description: The timestamp when the workspace was created. example: '2025-10-29T00:40:06.000000Z' updated_at: type: string format: date-time description: The timestamp when the workspace was last updated. example: '2025-10-29T00:40:06.000000Z' archived_at: type: string format: date-time nullable: true description: The timestamp when the workspace was archived. example: null ErrorResponse: type: object properties: type: type: string description: A broad category for the error (e.g., 'invalid_request_error'). example: invalid_request_error code: type: string description: A short, unique string identifying the specific error. example: parameter_missing message: type: string description: A human-readable description of what went wrong. example: The 'name' parameter is required for this request. doc_url: type: string description: >- A direct link to the documentation page for this specific error code. example: https://docs.altostrat.io/errors/parameter_missing responses: BadRequest: description: >- Bad Request - The request was malformed or contained invalid parameters. The response body will contain details about the error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: type: invalid_request_error code: parameter_invalid message: The 'name' parameter cannot exceed 50 characters. doc_url: https://docs.altostrat.io/errors/parameter_invalid Unauthorized: description: >- Unauthorized - The request was not authenticated. Ensure you have provided a valid Bearer token in the Authorization header. Forbidden: description: >- Forbidden - The authenticated user does not have permission to perform this action. NotFound: description: Not Found - The requested resource could not be found. ServerError: description: Internal Server Error - An unexpected error occurred on the server. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: type: api_error code: internal_server_error message: An internal server error occurred. Please try again later. doc_url: https://docs.altostrat.io/errors/internal_server_error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Enter your JWT in the format: Bearer {token}' ````