Sign in

v1

latestOpenAPI 3.1.02026-07-264793109.1 KB
3. Sites

Onboard

Initialise a site and its assets, and enrol them in a proposition in a single call.

This endpoint will:

  1. Upsert the site and asset(s)
  2. Enrol in the relevant flex proposition

The response returns the site and asset IDs you'll use in subsequent calls, and the enrolment outcome.

Onboarding is idempotent and atomic — sending the same site or asset returns the existing record with any new fields merged in; if enrolment fails, nothing is stored.

post/entities/site/onboard

Request body

proposition'limited_pause' | 'full_asset_schedule_control' required

Proposition to enrol the site in

override_withdrawalboolean

Set to true to re-enrol regardless of previous withdrawals.

Example request

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

Response

Site and assets persisted, site enrolled in proposition

Example response

{
  "enrolment": {
    "site_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "enrolled"
  }
}