---
title: "Update workspace state"
method: PATCH
path: "/api/workspaces/{id}"
---

# Update workspace state

`PATCH /api/workspaces/{id}`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/workspaces/{id}`
- Auth: API key in header `X-API-KEY`

Only a few of the workspace options could be updated.

## Path parameters

- `id` string, uuid, required

## Request body

- RequestWorkspaceUpdateResource
  - `data` WorkspaceUpdateResource, required
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` WorkspaceUpdateResourceWorkspaceAttributes, required
      - `isAiTrialActive` boolean, nullable, required

## Response `200`

The updated workspace

- SingleResourceBodyWorkspaceResource
  - `data` WorkspaceResource
    - `type` string, required
    - `id` string, required
    - `attributes` WorkspaceResourceWorkspaceAttributes, required
      - `name` string, required
      - `url` string, required
      - `current` boolean, required
      - `maxUserCount` integer, required
      - `workspaceStorage` integer, required
      - `subscriptionTier` 'INTERNAL' | 'TRIAL' | 'FREE' | 'STARTER' | 'BUSINESS' | 'ENTERPRISE', required
      - `subscriptionEndDate` string, date-time, required
      - `trialExtended` boolean, required
      - `lastActive` string, date-time, required
      - `staleReminderSent` boolean, required
      - `isSlicedByCustomer` boolean, required
      - `isAiActive` boolean, required
      - `aiTrialStartDate` string, date-time, required
      - `aiTrialEndDate` string, date-time, nullable
      - `activeItemLimit` integer, required
    - `meta` WorkspaceResourceWorkspaceMeta, required
      - `usedStorage` integer, required
      - `accessibleStorage` integer, required
      - `activeItemCount` integer, required
  - `errors` ProblemDetail[]: A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.
    - `id` string: A unique identifier for this specific error occurrence. Useful for debugging and support.
    - `links` object, nullable: Links related to the error. May include a URL to relevant documentation or support resources.
    - `status` integer: The HTTP status code associated with the error (e.g., 400, 404, 422).
    - `code` string: An internal code that identifies the type or category of the error.
    - `title` string: A short summary of the problem.
    - `source` ProblemSource: Identifies the part of the request that caused the error. Only one source is present per error.
      - `pointer` string, nullable: Specifies the path to the field in the request body that caused the error.
      - `parameter` string, nullable: Identifies a query parameter in the request URL that caused the error.
      - `header` string, nullable: Identifies the request header that caused the error.
    - `detail` string: Additional information about the error, intended to provide more context than the title.
    - `meta` unknown
  - `meta` unknown
  - `included` unknown[]: A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).
    - unknown
  - `links` unknown

---

[API](https://skmtc.dev/atono/apis/backend-api.md) · [All operations](https://skmtc.dev/atono/apis/backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atono/apis/backend-api/revisions/78a57b1d8c3d?raw)