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

# Save a device

> Add a catalog device to your saved list, or relabel one you already saved. Repeating the call updates the existing entry instead of adding a second one. A catalog device Leap has retired returns 404.



## OpenAPI

````yaml /api-reference/specs/gcs-devices.json put /beta/incentives/devices/saved/{device_id}
openapi: 3.0.1
info:
  title: Leap Incentives — Devices
  description: >-
    API for managing program definitions, requirement catalog, field groups, and
    partner data preferences
  contact:
    email: apiteam@leap.energy
  version: '0.1'
servers:
  - url: https://api.leap.energy
    description: Production
  - url: https://api.staging.leap.energy
    description: Staging
security:
  - BearerAuth: []
tags:
  - name: devices
paths:
  /beta/incentives/devices/saved/{device_id}:
    put:
      tags:
        - devices
      summary: Save a device
      description: >-
        Add a catalog device to your saved list, or relabel one you already
        saved. Repeating the call updates the existing entry instead of adding a
        second one. A catalog device Leap has retired returns 404.
      operationId: upsertSavedDevice
      parameters:
        - name: device_id
          in: path
          required: true
          description: Catalog device UUID (as returned by the device search).
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SavedDeviceUpsertRequest'
      responses:
        '200':
          description: The saved device after the upsert.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedDeviceResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    SavedDeviceUpsertRequest:
      type: object
      properties:
        label:
          type: string
          nullable: true
          maxLength: 256
          description: >-
            Your own name for the device, to help you find it later. Omit the
            key to keep the current label, send null or a blank string to clear
            it, send text to set it. Maximum 256 characters.
    SavedDeviceResponse:
      type: object
      required:
        - device_id
        - created_at
        - device
      properties:
        device_id:
          type: string
          format: uuid
          description: Catalog device UUID. This is the `device_id` you send on a lookup.
        label:
          type: string
          nullable: true
          description: Your own name for the device, when you set one. Null otherwise.
        created_at:
          type: string
          format: date-time
          description: When you first saved this device.
        device:
          $ref: '#/components/schemas/PartnerDeviceResponse'
    PartnerDeviceResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        device_category_id:
          type: string
          format: uuid
          description: >-
            Leap's identifier for the device's category. It is specific to one
            Leap environment, so key on `device_category` instead when you store
            or compare categories.
        device_category:
          type: string
          description: >-
            The device's category name, and the stable way to address a
            category: `hvac`, `ev_charger`, `solar_storage`, `water_heater`,
            `smart_thermostat`, `weatherization`, `vehicle`, `meter`,
            `panel_make_ready`, `solar_panel`. It is the same value the
            `category` query parameter takes, so you can bucket a page of
            results without a second call.
        manufacturer:
          type: string
        model_number:
          type: string
        model_name:
          type: string
        description:
          type: string
        subcategory:
          type: string
        is_active:
          type: boolean
        date_available:
          type: string
          format: date
        date_discontinued:
          type: string
          format: date
        manufacture_year:
          type: integer
        charger_level:
          type: string
        charging_power_kw:
          type: number
        connector_types:
          type: array
          items:
            type: string
        seer2_rating:
          type: number
        eer2_rating:
          type: number
        hspf2_rating:
          type: number
        ceer_rating:
          type: number
        capacity_tons:
          type: number
        capacity_btu:
          type: integer
        capacity_kw:
          type: number
        msrp:
          type: number
        is_energy_star_certified:
          type: boolean
        is_ul_listed:
          type: boolean
        is_networked:
          type: boolean
        is_ocpp_compliant:
          type: boolean
        battery_capacity_kwh:
          type: number
        battery_chemistry:
          type: string
        is_mobile_plugin_charger:
          type: boolean
      description: >-
        One device in Leap's catalog. Send its `id` as the `device_id` on a
        lookup. Specification fields such as `capacity_kw` or `seer2_rating` are
        populated where Leap holds data for that device type, and are null
        otherwise.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  error_code:
                    type: string
                  reason:
                    type: string
  responses:
    BadRequest:
      description: Malformed or invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: You are not authorized to perform this operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: You do not have permission to perform this operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: >
        The shared per-partner rate limit for /incentives endpoints was exceeded
        (`error_code: RATE_LIMIT_EXCEEDED`). Back off and retry after the number
        of seconds indicated by the `Retry-After` header.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: An internal server error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Leap API key as a Bearer token. Send it in the `Authorization`
        header: `Authorization: Bearer <api-key>`.

````