3. Sites

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

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/site/{site_id}/unenrol
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Path parameters

site_idstring uuid required

Request body

Response

Successfully unenrolled or already unenrolled

site_idstring uuid required

ID of the unenrolled site

status'unenrolled' | 'already_unenrolled' required

Example response

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

Changes

    • breaking

      removed the enum value full_asset_schedule_control of the request property

    • breaking

      removed the enum value limited_pause of the request property

    • breaking

      the request property type changed from string to no type

    • info

      added subschema #1 to the request property anyOf list