Skip to main content
POST
Cancel a VPP event

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

vpp_event_id
string
required

Flatpeak VPP event ID.

Response

VPP event response.

One market activation: a power target per interval for one group. The event takes every device in the group at creation and records each one in its device list. Plans are separate: they run devices under a managed tariff.

id
string
required

Flatpeak VPP event ID.

Example:

"vpe_7d2a4c6e9b1f3a5c8e0d2f4b"

object
enum<string>
required

Object type, vpp_event.

Available options:
vpp_event
Example:

"vpp_event"

live_mode
boolean
required

true for live data, false for test data.

Example:

true

reference_id
string | null
required

Your reference for the activation, for example the market operator's. Unique per account: a second event with the same reference_id returns 409, so creation is safe to retry.

Example:

"NG-DFS-2026-08-04-EV17"

event_type
enum<string>
required

ECONOMIC: market-driven, the default. TEST: exercises the dispatch chain without settlement.

Available options:
ECONOMIC,
TEST
Example:

"ECONOMIC"

group_id
string
required

The group the event dispatches. The event took every device that was in the group when it was created; later changes to the group do not change the event.

Example:

"grp_2f6a9c1d8e3b5a7c4d0e9f1a"

intervals
object[]
required

Ordered, non-overlapping intervals, each with a signed power_kw target for the group. A flat event is one interval.

Minimum array length: 1
start_time
string<date-time>
required
read-only

Event envelope start: the first interval's start, in UTC. Read only.

Example:

"2026-08-04T20:14:00Z"

end_time
string<date-time>
required
read-only

Event envelope end: the last interval's end, in UTC. Read only.

Example:

"2026-08-04T22:00:00Z"

status
enum<string>
required
read-only

Lifecycle status, the same values the Energy API reports to OEMs. Changes fire vpp_event.update.

Available options:
ALLOCATION_OPEN,
LOCKED,
ACTIVE,
COMPLETE,
CANCELED
Example:

"ALLOCATION_OPEN"

time_allocation_locks
string<date-time>
required
read-only

Time after which the allocation is fixed, in UTC. Until then Flatpeak may rebalance shares.

Example:

"2026-08-25T16:00:00Z"

device_count
integer
required
read-only

Devices the event took from the group when it was created. Each one is in the event's device list, whether or not it was given a share.

Example:

1930

delivery
object
required
read-only

Requested, committed and delivered figures for the whole event: the sum across the event's devices. Kept current as meter records arrive.

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2026-08-03T11:20:00Z"

time_updated
string<date-time>
required

Time when the event was created or last updated, in UTC.

Example:

"2026-08-25T14:00:12Z"

account_id
string
required

Flatpeak Account ID of the operator that owns the VPP event.

Example:

"acc_63e2f1b9a4c8d05f7e3a9b1c"