v1

latestOpenAPI 3.1.02026-07-264793109.1 KB

3. Sites

Initialise Site

Initialise a site with one or more assets.

This endpoint upserts the site and assets (creating them if they don't exist, or filling in missing fields if they do), and returns eligibility information.

No enrollment side effects: Use the /enrol endpoint to commit to enrollment.

post/entities/site/initialise

Request body

Example request

{
  "assets": [
    {
      "external_id": "charger-001",
      "type": "charger",
      "asset_model": "zappi",
      "installation_date": "2025-06-15",
      "properties": {
        "power_kw": 7.4
      }
    }
  ]
}

Response

Successfully initialised site and assets

Example response

{
  "eligibility": {
    "site_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "assets": [
      {
        "asset_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
        "external_id": "charger-001",
        "propositions": [
          {
            "proposition": "limited_pause"
          }
        ]
      }
    ]
  }
}