Skip to main content
POST
/
entities
/
site
/
{site_id}
/
enrol
Enrol Site
curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/enrol \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "override_withdrawal": false,
  "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}
'
{
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.axle.energy/llms.txt

Use this file to discover all available pages before exploring further.

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:
limited_pause,
full_asset_schedule_control
​
override_withdrawal
boolean
default:false

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

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

Successfully enrolled or already enrolled

Outcome of an enrolment attempt.

​
site_id
string<uuid>
required

ID of the enrolled site

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
status
enum<string>
required

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

Available options:
enrolled,
already_enrolled
Example:

"enrolled"