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

Enrol Site

cURL

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/enrol \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "proposition": "limited_pause",
  "override_withdrawal": false,
  "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}
'

200

{
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "enrolled"
}

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 enrolling a site in a proposition.

proposition · enum<string> · required

Proposition to enrol for

Available options: cm_infrequent_dispatch, full_asset_schedule_control, limited_pause, vpp_limited_control

Example:

"limited_pause"

override_withdrawal · boolean · default: false

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

Example:

false

gave_boundary_meter_consent_at · string<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

200

application/json

Successfully enrolled or already enrolled

Response model for the enrol endpoint.

site_id · string<uuid> · required

ID of the enrolled site

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

status · enum<string> · required

Available options: enrolled, already_enrolled

Example:

"enrolled"