Update Workspace

patch/v1/workspaces/{workspace_id}

Updates a workspace's settings, and optionally re-points its own_company. Only supplied attributes change. Side effect: writes the workspace row and, when own_company is given, links the workspace to that company. Requires workspace admin.

Requires a bearer token: Authorization: Bearer <token>.

Path parameters

NameTypeRequiredDescription
workspace_idstring <uuid>YesPublic UUID of the workspace.e.g. 8f6b2c10-4a1e-4d2b-9c3a-1f0e7a5b6c21

Request

cURL
curl -X PATCH https://api.wellapp.ai/v1/workspaces/{workspace_id} \
  -H "Authorization: Bearer $WELL_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {
    "type": "workspace",
    "attributes": {
      "name": "Foldspace AI",
      "stage": "active"
    }
  }
}'
Request body
{
  "data": {
    "type": "workspace",
    "attributes": {
      "name": "Foldspace AI",
      "stage": "active"
    }
  }
}

Responses

200 — The updated workspace.

{
  "data": {
    "type": "workspace",
    "id": "8f6b2c10-4a1e-4d2b-9c3a-1f0e7a5b6c21",
    "attributes": {
      "name": "Foldspace AI",
      "description": "Production finance workspace for the Foldspace team.",
      "avatar_image": null,
      "avatar_color": "#5B8DEF",
      "external_workspace_id": null,
      "trusted": false,
      "auto_extract_enabled": true,
      "stage": "active",
      "timezone": "America/Los_Angeles",
      "parent_workspace_id": null,
      "created_at": "2026-01-12T09:29:00.000Z",
      "updated_at": "2026-05-21T07:45:00.000Z"
    },
    "relationships": {
      "media": {
        "data": {
          "type": "media",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "parent_workspace": {
        "data": {
          "type": "workspace",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "own_company": {
        "data": {
          "type": "company",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "child_workspaces": {
        "data": [
          {
            "type": "workspace",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        ]
      },
      "memberships": {
        "data": [
          {
            "type": "membership",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        ]
      },
      "webhooks": {
        "data": [
          {
            "type": "webhook",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        ]
      },
      "workspace_accounting_settings": {
        "data": {
          "type": "workspace_accounting_settings",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "workspace_providers": {
        "data": [
          {
            "type": "workspace_provider",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        ]
      }
    }
  }
}

400 — Bad Request

{
  "code": "BAD_REQUEST",
  "status": 400,
  "title": "Bad Request",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

401 — Unauthorized

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

403 — Forbidden

{
  "code": "FORBIDDEN",
  "status": 403,
  "title": "Forbidden",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

404 — Not Found

{
  "code": "NOT_FOUND",
  "status": 404,
  "title": "Not Found",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}