Sign in

v1

latestOpenAPI 3.1.02026-07-264793109.1 KB
3. Sites

Enrol Site

Enrol a site in a proposition.

This is the commitment point — it activates the proposition for the site.

Idempotent: if the site is already enrolled, returns already_enrolled without making changes.

If the site previously withdrew from this proposition, returns 422. Set override_withdrawal to true to re-enrol.

post/entities/site/{site_id}/enrol

Path parameters

site_idstring uuid required

Request body

proposition'limited_pause' | 'full_asset_schedule_control' required

Proposition to enrol for

override_withdrawalboolean

Set to true to re-enrol regardless of previous withdrawals. If this is a user-initated action, overriding previous withdrawals is recommended.

gave_boundary_meter_consent_atstring date-time

Optional timezone-aware ISO 8601 timestamp recording when the household gave boundary meter consent. If provided, overwrites any existing meter consent timestamp on the site.

Response

Successfully enrolled or already enrolled

site_idstring uuid required

ID of the enrolled site

status'enrolled' | 'already_enrolled' required

Outcome of the enrolment attempt. Both enrolled and already_enrolled indicate success.

Example response

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