HomeAPI ReferenceSupport
API Reference

Set Overlay Plan

put
https://developer-api.customer.mygridshare.com/api/v2/devices//plans/overlay

Set an overlay plan for the device. To delete an overlay plan, send an empty commands array in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the device.

Body Params

The representation of the overlay plan

date-time
required

The ISO8601 datetime at which the command should take effect.

commands
array
required

List of commands. Commands are executed in the order they appear in the list. The durationMinutes of each command determines how long the command is active before the next command in the list is executed. There are no gaps between commands.

commands*
Responses
204

204 response

Updated 26 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 26 days ago