HomeAPI ReferenceSupport
API Reference

Create

post
https://developer-api.partner.mygridshare.com/api/v1/flexEvent

Create a flex event for a defined flex group. This endpoint supports the creation of flat dispatch events, events that achieve a flat power profile within a specified time frame.

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

ID of the flex group associated with this event.

date-time
required

Start time of the flex event.

date-time
required

End time of the flex event.

string
enum
required

Type of the flex event. Currently, only 'flat' is supported.

Allowed:
number
required

Power in watts to be constantly dispatched throughout the duration of the entire event.

string
enum
required

Status of the flex event.

Allowed:
boolean
Defaults to true

If false, returns an error if event overlaps with existing events. When true allows overlapping events to be scheduled.

Responses

Updated about 1 month ago

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

Updated about 1 month ago