Onboarding

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.

A 200 response always means the site is enrolled; status only distinguishes a new enrolment from an existing one. Any failure returns an HTTP error and leaves the site unenrolled, so fix the cause and call again.

If the site previously withdrew from this proposition (for example via /unenrol), returns 422 with detail.code set to previously_withdrew. Set override_withdrawal to true to re-enrol; this is the recommended default for user-initiated re-enrolment.

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 '
{
  "proposition": "limited_pause",
  "override_withdrawal": false,
  "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api-sandbox.axle.energy/entities/site/{site_id}/enrol"

payload = {
    "proposition": "limited_pause",
    "override_withdrawal": False,
    "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    proposition: 'limited_pause',
    override_withdrawal: false,
    gave_boundary_meter_consent_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api-sandbox.axle.energy/entities/site/{site_id}/enrol', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.axle.energy/entities/site/{site_id}/enrol",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'proposition' => 'limited_pause',
    'override_withdrawal' => false,
    'gave_boundary_meter_consent_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.axle.energy/entities/site/{site_id}/enrol"

	payload := strings.NewReader("{\n  \"proposition\": \"limited_pause\",\n  \"override_withdrawal\": false,\n  \"gave_boundary_meter_consent_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.axle.energy/entities/site/{site_id}/enrol")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"proposition\": \"limited_pause\",\n  \"override_withdrawal\": false,\n  \"gave_boundary_meter_consent_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/entities/site/{site_id}/enrol")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"proposition\": \"limited_pause\",\n  \"override_withdrawal\": false,\n  \"gave_boundary_meter_consent_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": {
    "message": "Prerequisites not met for proposition: limited_pause",
    "code": "previously_withdrew",
    "eligibility": {
      "site_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "site_properties": {
        "has_meter_consent": true,
        "is_half_hourly_settled": false
      },
      "eligible_propositions": [],
      "assets": []
    }
  }
}

{
  "detail": "<string>"
}

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,

price_curve

Example:

"limited_pause"

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

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"

⌘I

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 '
{
  "proposition": "limited_pause",
  "override_withdrawal": false,
  "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api-sandbox.axle.energy/entities/site/{site_id}/enrol"

payload = {
    "proposition": "limited_pause",
    "override_withdrawal": False,
    "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    proposition: 'limited_pause',
    override_withdrawal: false,
    gave_boundary_meter_consent_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api-sandbox.axle.energy/entities/site/{site_id}/enrol', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.axle.energy/entities/site/{site_id}/enrol",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'proposition' => 'limited_pause',
    'override_withdrawal' => false,
    'gave_boundary_meter_consent_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.axle.energy/entities/site/{site_id}/enrol"

	payload := strings.NewReader("{\n  \"proposition\": \"limited_pause\",\n  \"override_withdrawal\": false,\n  \"gave_boundary_meter_consent_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.axle.energy/entities/site/{site_id}/enrol")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"proposition\": \"limited_pause\",\n  \"override_withdrawal\": false,\n  \"gave_boundary_meter_consent_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/entities/site/{site_id}/enrol")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"proposition\": \"limited_pause\",\n  \"override_withdrawal\": false,\n  \"gave_boundary_meter_consent_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": {
    "message": "Prerequisites not met for proposition: limited_pause",
    "code": "previously_withdrew",
    "eligibility": {
      "site_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "site_properties": {
        "has_meter_consent": true,
        "is_half_hourly_settled": false
      },
      "eligible_propositions": [],
      "assets": []
    }
  }
}

{
  "detail": "<string>"
}

Home

Assets

Core workflows

EV Charging

Batteries & Heating

Enrol site

Authorizations

Path Parameters

Body

Response