Advanced Onboarding

Unenrol site

Unenrol a site from a proposition.

Withdraws the site from the proposition and prevents further scheduling. Does not delete the site or its assets.

Use when the user is opting out of this proposition specifically — for example, they toggled it off in your app. The site and assets are kept, any other propositions they’re enrolled in (such as Capacity Market) are unaffected, and the user can re-enrol later and still access their payments.

If the user is leaving entirely (moving house, support-led removal, etc.), use offboard-site-and-assets instead.

Idempotent: if the site is already unenrolled, returns already_unenrolled without making changes.

POST

entities

site

{site_id}

unenrol

Unenrol Site

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/unenrol \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

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

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 unenrolling a site from a proposition.

proposition

enum<string>

required

Proposition to unenrol from

Available options:

limited_pause,

full_asset_schedule_control

Response

Successfully unenrolled or already unenrolled

Response model for the unenrol endpoint.

site_id

string<uuid>

required

ID of the unenrolled site

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

status

enum<string>

required

Available options:

unenrolled,

already_unenrolled

Example:

"unenrolled"

Get all assetsGet all assets with pagination. Returns a page of assets with the total count and the requested subset of asset records. Use the limit and offset parameters to navigate through pages of results.

⌘I

Unenrol Site

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/unenrol \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

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

Documentation Index

Authorizations

Path Parameters

Body

Response