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

# Update environmental impact

> Partial update: only the keys in the body are applied. The product cannot change; delete and recreate to move it. A null clears a nullable field; an empty body is a 422. Requires CONTRIBUTE on the owning organization.



## OpenAPI

````yaml /openapi/openapi-sustainability.json patch /sustainability/api/v1/environmental-impacts/{record_id}
openapi: 3.1.0
info:
  title: Sustainability API
  version: 1.0.0
  description: >
    Product sustainability data: circularity scores, recyclability, packaging
    breakdown, major components, end-of-life instructions, and environmental
    impact assessments.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Sustainability
    description: Read-only product sustainability queries keyed by GTIN.
  - name: Packaging
    description: Packaging elements of a product. Create, read, update and delete.
  - name: Recyclability
    description: Recyclability assessments of packaging elements.
  - name: End-of-life instructions
    description: Disposal instructions for a product or component.
  - name: Environmental impacts
    description: Quantified environmental impact assessments.
  - name: Production processes
    description: Production process stages and the process-type catalog.
  - name: Transport impacts
    description: Transport legs and their emissions.
  - name: Substances of concern
    description: Regulated substances present in a product.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /sustainability/api/v1/environmental-impacts/{record_id}:
    patch:
      tags:
        - Environmental impacts
      summary: Update environmental impact
      description: >-
        Partial update: only the keys in the body are applied. The product
        cannot change; delete and recreate to move it. A null clears a nullable
        field; an empty body is a 422. Requires CONTRIBUTE on the owning
        organization.
      operationId: apps_sustainability_api_records_update_environmental_impact
      parameters:
        - in: path
          name: record_id
          schema:
            description: Id of the environmental impact.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Record Id
            type: string
          required: true
          description: Id of the environmental impact.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentalImpactRecordUpdate'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentalImpactRecordOut'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '409':
          description: Conflict
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    EnvironmentalImpactRecordUpdate:
      description: >-
        Payload for ``PATCH /environmental-impacts/{id}``. Only the keys present
        are applied.
      examples:
        - notes: Re-run with 2026 grid data.
          score_value: 2.1
      properties:
        impact_type:
          anyOf:
            - $ref: '#/components/schemas/ImpactTypeEnum'
            - type: 'null'
          description: Category of environmental effect measured.
        score_value:
          anyOf:
            - maximum: 99999999999
              minimum: -99999999999
              type: number
            - type: 'null'
          description: Magnitude of the impact in ``unit``.
          title: Score Value
        unit:
          anyOf:
            - description: >-
                Unit ``score_value`` is expressed in: kg CO2e, kg, t, L, m³, m²,
                MJ, kWh, % or Other.
              examples:
                - kg CO2e
              maxLength: 10
              minLength: 1
              pattern: ^(kg\ CO2e|kg|t|L|m³|m²|MJ|kWh|%|Other)$
              type: string
            - type: 'null'
          description: Unit ``score_value`` is expressed in.
          title: Unit
        methodology_reference:
          anyOf:
            - maxLength: 200
              pattern: ^[^\x00]{0,200}$
              type: string
            - type: 'null'
          description: Standard or method used. Null clears it.
          title: Methodology Reference
        assessment_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Date of the assessment. Null clears it.
          title: Assessment Date
        notes:
          anyOf:
            - maxLength: 1000
              pattern: ^[^\x00]{0,1000}$
              type: string
            - type: 'null'
          description: Scope, assumptions or data source. Null clears it.
          title: Notes
      title: EnvironmentalImpactRecordUpdate
      type: object
    EnvironmentalImpactRecordOut:
      description: A quantified environmental impact of one of the organization's products.
      examples:
        - assessment_date: '2026-04-15'
          created: '2026-09-30T09:00:00Z'
          gtin: '00850012345688'
          id: F5n5NdW6dTbvPYkgnLNjte
          impact_type: CARBON_FOOTPRINT
          methodology_reference: ISO 14067:2018
          modified: '2026-09-30T09:00:00Z'
          notes: Cradle-to-gate assessment including transport.
          organization_id: 9fHkqR2aXcVbNmLpQwErTy
          score_value: 2.4
          unit: kg CO2e
      properties:
        id:
          description: >-
            URL-safe 22-character shortuuid encoding of the row's UUID primary
            key. Stable across the row's lifetime; suitable for sharing in URLs,
            log lines, and external SDK clients. Accepted on input as either the
            shortuuid form or the canonical UUID form
            (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``).
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        organization_id:
          description: The organization that owns the product.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Organization Id
          type: string
        gtin:
          description: The product's GTIN, normalized to GTIN-14.
          title: Gtin
          type: string
        created:
          description: Server-side ISO 8601 timestamp of creation (UTC).
          format: date-time
          title: Created
          type: string
        modified:
          description: Server-side ISO 8601 timestamp of last modification (UTC).
          format: date-time
          title: Modified
          type: string
        impact_type:
          description: Category of environmental effect measured.
          title: Impact Type
          type: string
        score_value:
          description: Magnitude of the impact, expressed in ``unit``.
          title: Score Value
          type: number
        unit:
          description: Unit ``score_value`` is expressed in.
          title: Unit
          type: string
        methodology_reference:
          description: Standard or method used. Empty when unset.
          title: Methodology Reference
          type: string
        assessment_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Date of the assessment. Null when unset.
          title: Assessment Date
        notes:
          description: Scope, assumptions or data source. Empty when unset.
          title: Notes
          type: string
      required:
        - id
        - organization_id
        - gtin
        - created
        - modified
        - impact_type
        - score_value
        - unit
        - methodology_reference
        - assessment_date
        - notes
      title: EnvironmentalImpactRecordOut
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
    ImpactTypeEnum:
      description: |-
        Environmental impact category.

        Mirror of ``apps.sustainability.models.EnvironmentalImpact.ImpactType``.
      enum:
        - CARBON_FOOTPRINT
        - WATER_USAGE
        - ENERGY_CONSUMPTION
        - WASTE_GENERATION
        - LAND_USE
        - OTHER
      title: ImpactTypeEnum
      type: string
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````