Battery

Set this battery's schedule

Set or replace the schedule on this battery. The schedule’s contents are device config, so they are written on the device itself rather than posted to a separate resource. The body is a non-empty slots array (each slot an at absolute-timestamp variant or a time wall-clock variant), an optional recurrence rule, and a schedule-level IANA timezone for time-variant slots. The route is published ahead of the scheduler; every call returns 501 until it lands.

PUT

battery

{deviceId}

schedule

curl

curl --request PUT \
  --url 'https://api.amps.ai/battery/device_abc123/schedule' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --data '{
    "timezone": "Europe/London",
    "recurrence": {
      "rule": "daily"
    },
    "slots": [
      {
        "time": "00:30",
        "duration": "PT5H",
        "command": "charge",
        "parameters": {
          "target": {
            "value": 100,
            "unit": "percent"
          }
        }
      }
    ]
  }'

{
  "id": "sched_abc123",
  "deviceId": "device_abc123",
  "deviceType": "battery",
  "state": "active",
  "timezone": "Europe/London",
  "recurrence": {
    "rule": "daily"
  },
  "slots": [
    {
      "time": "00:30",
      "duration": "PT5H",
      "command": "charge",
      "parameters": {
        "target": {
          "value": 100,
          "unit": "percent"
        }
      }
    }
  ],
  "updatedAt": "2026-06-01T12:00:00.000Z",
  "nextFireAt": "2026-06-02T00:30:00.000Z"
}

Authorizations

x-api-key

string

header

required

Path Parameters

deviceId

string

required

The unique identifier for the battery device.

Example:

"device_abc123"

Body

application/json

The schedule to set on the device: a non-empty slots array, an optional recurrence, and an optional timezone (required for time-variant slots). No deviceId in the body; the device is the URL.

The body is of type string.

Response

Schedule set on the device.

Clear this battery's scheduleClear the schedule set on this battery. The route is published ahead of the scheduler; every call returns 501 until it lands.

curl

curl --request PUT \
  --url 'https://api.amps.ai/battery/device_abc123/schedule' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --data '{
    "timezone": "Europe/London",
    "recurrence": {
      "rule": "daily"
    },
    "slots": [
      {
        "time": "00:30",
        "duration": "PT5H",
        "command": "charge",
        "parameters": {
          "target": {
            "value": 100,
            "unit": "percent"
          }
        }
      }
    ]
  }'

{
  "id": "sched_abc123",
  "deviceId": "device_abc123",
  "deviceType": "battery",
  "state": "active",
  "timezone": "Europe/London",
  "recurrence": {
    "rule": "daily"
  },
  "slots": [
    {
      "time": "00:30",
      "duration": "PT5H",
      "command": "charge",
      "parameters": {
        "target": {
          "value": 100,
          "unit": "percent"
        }
      }
    }
  ],
  "updatedAt": "2026-06-01T12:00:00.000Z",
  "nextFireAt": "2026-06-02T00:30:00.000Z"
}