AXaxle
3. Sites

Update Site

Changed on

Update an existing site's information.

Only fields included in the request will be updated. Returns the updated site details.

patch/entities/site/{site_id}

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/site/{site_id}
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Path parameters

site_idstring uuid required

Request body

addressstring

Full address for the site

postcodestring

UK postcode for the site

mpanstring

Meter Point Administration Number

emailstring

Email address for the site

proposition'mileage_subscription' | 'supplier_ev_tariff'

Commercial propositions a site can be enrolled in (org-scoped; see PropositionConfig).

Deliberately separate from DispatchMethodResponse: propositions are single-choice and mutually exclusive per site, unlike dispatch consents which are set-based.

Response

Successful Response

idstring uuid required

Axle's internal UUID for the site

mpanstring

Meter Point Administration Number for the site

postcodestring

UK postcode for the site

addressstring

Full address for the site

asset_idsstring[]

List of asset IDs associated with this site

marketsMarketResponse[]

Markets the site is participating in

dispatch_methodsDispatchMethodResponse[]

Dispatch methods allowed for the site

gave_boundary_meter_consent_atstring date-time

Timestamp when boundary meter consent was given

Changes

  • b0b07b1dbf12Revision changes
    • warning

      removed from the request property allOf list

    • warning

      added the new price_curve enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added to the request property anyOf list