Skip to main content
PUT
Save a device

Authorizations

Authorization
string
header
required

Your Leap API key as a Bearer token. Send it in the Authorization header: Authorization: Bearer <api-key>.

Path Parameters

device_id
string<uuid>
required

Catalog device UUID (as returned by the device search).

Body

application/json
label
string | null

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.

Maximum string length: 256

Response

The saved device after the upsert.

device_id
string<uuid>
required

Catalog device UUID. This is the device_id you send on a lookup.

created_at
string<date-time>
required

When you first saved this device.

device
object
required

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.

label
string | null

Your own name for the device, when you set one. Null otherwise.