Skip to main content
PATCH
Update Site

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

site_id
string<uuid>
required

Body

application/json

Request model for updating site information.

tariff
TariffWithRates · object

Tariff to set for the site: a full tariff (rates + periods) or window-only (off-peak times + type). Full tariffs are persisted and pushed to the scheduler.

address
string

Full address for the site

postcode
string

UK postcode for the site

mpan
string

Meter Point Administration Number

email
string

Email address for the site

proposition
enum<string>

Commercial proposition to enrol this site in. Set once per site; enrolling in a different proposition requires unenrolling from the current one first (POST /entities/site/{site_id}/unenrol).

Available options:
mileage_subscription,
supplier_ev_tariff

Response

Successful Response

Response model for site information.

id
string<uuid>
required

Axle's internal UUID for the site

mpan
string

Meter Point Administration Number for the site

postcode
string

UK postcode for the site

address
string

Full address for the site

asset_ids
string<uuid>[]

List of asset IDs associated with this site

markets
enum<string>[]

Markets the site is participating in

Market types available for participation.

  • CM: Capacity Market
  • DFS: Dynamic Frequency Service
  • DNO: Distribution Network Operator flexibility services
  • LCM: Local Capacity Market
  • SFFR: Static Firm Frequency Response
  • WHOLESALE: Wholesale energy market
Available options:
cm,
dfs,
dno,
lcm,
sffr,
wholesale
dispatch_methods
enum<string>[]

Dispatch methods allowed for the site

Axle propositions that a site can enrol into.

Available options:
cm_infrequent_dispatch,
full_asset_schedule_control,
limited_pause,
vpp_limited_control
tariff
Tariff · object

Tariff information for the site

Timestamp when boundary meter consent was given