> ## Documentation Index
> Fetch the complete documentation index at: https://connectionshub.atlastube.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Sheet Inputs

> Update a sheet's input attributes. Keys are widget reference IDs from the template (see `GET /v1/templates/{code}`). The set is applied as one unit: values are checked against the template, and a value it rejects returns `422` naming the field in `details` with nothing written — a sheet never holds part of an update. A key that matches no widget on the template is accepted but not written: the response names it in `warnings` and leaves it out of `updatedAttributes`, which lists exactly the keys this request stored. An explicit `null` is skipped the same way (reported with a `null_value` warning), never treated as clearing the field. Updating does not recalculate — solve the sheet to refresh results. The [Sheet Lifecycle guide](/templates/sheets-lifecycle) walks all four steps on one calculation.



## OpenAPI

````yaml api/openapi.json PATCH /v1/sheets/{sheetId}
openapi: 3.1.0
info:
  title: Connections Hub API
  version: 1.0.0
  description: >-
    Run HSS Connections Hub calculators programmatically: create projects,
    create and solve sheets from any calculator template, run batches, and
    export reports to PDF.


    All endpoints require API key authentication.
servers:
  - url: https://api.calcs.com
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Create and manage calculation projects. Each user can have multiple
      projects to organize their calculations.
  - name: Sheets
    description: >-
      Manage individual calculation sheets — read one back, update its inputs,
      solve or re-solve it, and delete single sheets or clean up many at once.
  - name: Templates
    description: >-
      Run calculations using any enabled template. Supports all calculator types
      without requiring endpoint-specific code.
paths:
  /v1/sheets/{sheetId}:
    patch:
      tags:
        - Sheets
      summary: Update Sheet Inputs
      description: >-
        Update a sheet's input attributes. Keys are widget reference IDs from
        the template (see `GET /v1/templates/{code}`). The set is applied as one
        unit: values are checked against the template, and a value it rejects
        returns `422` naming the field in `details` with nothing written — a
        sheet never holds part of an update. A key that matches no widget on the
        template is accepted but not written: the response names it in
        `warnings` and leaves it out of `updatedAttributes`, which lists exactly
        the keys this request stored. An explicit `null` is skipped the same way
        (reported with a `null_value` warning), never treated as clearing the
        field. Updating does not recalculate — solve the sheet to refresh
        results. The [Sheet Lifecycle guide](/templates/sheets-lifecycle) walks
        all four steps on one calculation.
      operationId: update-sheet
      parameters:
        - name: Authorization
          in: header
          required: true
          example: Bearer YOUR_KEY_HERE
          schema:
            type: string
          description: >-
            The `Authorization` header is used to authenticate with the API
            using your API key. Value is of the format `Bearer YOUR_KEY_HERE`.
        - name: sheetId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            Sheet UUID. Accepted in canonical, uppercase, braced, or
            unhyphenated form, as `projectId` is on `POST
            /v1/templates/{code}/sheets`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - attributes
              properties:
                attributes:
                  type: object
                  additionalProperties: true
                  description: >-
                    Widget reference IDs and their new values. At least one key,
                    at most 200.
              example:
                attributes:
                  exposure: Partially Exposed
                  cond_thermal: Warm Roof (Ct = 1.0)
                  W: 30 ft
                  alpha_roof: 4
      responses:
        '200':
          description: The attributes were updated on the same sheet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SheetUpdateResponse'
              examples:
                updated:
                  summary: Four attributes updated
                  value:
                    sheetId: 84cb248b-a36f-41a9-9639-575bc597341e
                    status: unsolved
                    updatedAttributes:
                      - exposure
                      - cond_thermal
                      - W
                      - alpha_roof
        '400':
          description: >-
            The sheetId path parameter is not a valid UUID, or the request body
            is not valid JSON.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                non_uuid_sheet_id:
                  summary: sheetId is not a UUID
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: sheetId must be a UUID.
                malformed_json:
                  summary: Request body is not valid JSON
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: Invalid JSON in request body.
        '401':
          description: Unauthorized — missing or invalid API key.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                unauthorized:
                  summary: Missing or invalid API key
                  value:
                    type: https://httpproblems.com/http-status/401
                    title: Unauthorized
                    status: 401
                    detail: No Authorization Header
                    instance: /v1/sheets/84cb248b-a36f-41a9-9639-575bc597341e
                    trace:
                      timestamp: '2026-07-22T07:19:15.570Z'
                      requestId: 0a2d7511-aa02-45b6-86ce-1bb19c0486a2
                      buildId: 75f93f77-18bc-4f82-9a77-2e322a1bba58
                      rayId: a1f0ad123af1e6b3
        '404':
          description: The sheet does not exist, or is not accessible with this API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: Sheet does not exist, or is not accessible with this API key
                  value:
                    error:
                      code: NOT_FOUND
                      message: Sheet not found.
        '422':
          description: >-
            The request body is semantically invalid — an unrecognized top-level
            field, or `attributes` missing, empty, not an object, or over 200
            keys. Also returned when the template rejects one of the values,
            naming the field in `details`, and when the sheet cannot be modified
            because its project is archived. The sheet is left unchanged in
            every case.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                unknown_field:
                  summary: An unrecognized top-level field
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: 'Unknown field: attribtues. Allowed fields: attributes.'
                      details:
                        - field: attribtues
                          message: attribtues is not a recognized field.
                empty_attributes:
                  summary: attributes is empty
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: >-
                        attributes cannot be empty. Provide at least one widget
                        reference ID.
                      details:
                        - field: attributes
                          message: >-
                            attributes cannot be empty. Provide at least one
                            widget reference ID.
                not_an_object:
                  summary: attributes is not an object
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: >-
                        attributes must be an object mapping widget reference
                        IDs to values.
                      details:
                        - field: attributes
                          message: >-
                            attributes must be an object mapping widget
                            reference IDs to values.
      security:
        - api_key: []
components:
  schemas:
    SheetUpdateResponse:
      type: object
      description: >-
        Acknowledges an input update. Updating does not recalculate — solve the
        sheet to refresh results.
      properties:
        sheetId:
          type: string
          format: uuid
          description: Unique identifier for the sheet. Unchanged by updates.
        status:
          type: string
          enum:
            - unsolved
          description: Updated inputs take effect at the next solve.
        updatedAttributes:
          type: array
          items:
            type: string
          description: >-
            Reference IDs the sheet now holds from this request. A key the
            template does not define is skipped, so it is absent here and named
            in `warnings` — compare the two to confirm a write landed.
        warnings:
          type: array
          description: >-
            Keys that were not applied, and why. Absent when there is nothing to
            report.
          items:
            type: object
            properties:
              field:
                type: string
                description: The reference ID that was skipped.
              message:
                type: string
                description: What was wrong with it.
              type:
                type: string
                description: >-
                  Machine-readable reason: `unknown_field` for a key matching no
                  widget on the template, `null_value` for an explicit `null`
                  (skipped, not treated as a clear).
      required:
        - sheetId
        - status
        - updatedAttributes
    ValidationError:
      type: object
      description: Validation error response for invalid API inputs
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - VALIDATION_ERROR
              description: Error code for validation failures
            message:
              type: string
              description: Human-readable error summary
              example: Input validation failed
            details:
              type: array
              description: Array of specific validation errors
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: Path to the invalid field (e.g., 'L_X', 'supports.0.2')
                  message:
                    type: string
                    description: Description of what's wrong with the field
                required:
                  - field
                  - message
          required:
            - code
            - message
      required:
        - error
      example:
        error:
          code: VALIDATION_ERROR
          message: Input validation failed
          details:
            - field: L_X
              message: Expected number, received string
            - field: supports
              message: At least 2 supports are required
    ProblemDetails:
      type: object
      description: >-
        RFC 7807 (`application/problem+json`) error returned by the API gateway
        before a request reaches the handler — currently authentication failures
        (401). Note this differs from the `{ error: { code, message, details }
        }` envelope returned by the handler for validation and not-found errors.
      properties:
        type:
          type: string
          format: uri
          description: URI identifying the problem type.
        title:
          type: string
          description: Short, human-readable summary of the problem type.
        status:
          type: integer
          description: HTTP status code.
        detail:
          type: string
          description: Human-readable explanation specific to this occurrence.
        instance:
          type: string
          description: The request path that produced the error.
        trace:
          type: object
          description: >-
            Gateway trace metadata for support (timestamp, requestId, buildId,
            rayId).
      required:
        - type
        - title
        - status
        - detail
    ErrorResponse:
      type: object
      description: >-
        Standard error envelope for handler errors. `code` is a stable
        machine-readable error code (e.g. NOT_FOUND, UPSTREAM_ERROR); `message`
        is human-readable and may change.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send your API key as a bearer token: `Authorization: Bearer
        YOUR_API_KEY`. Every endpoint requires one.
    api_key:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.