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.

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

POST /entities/site/{site_id}/unenrol

Unenrol Site

cURL

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

200

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

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: cm_infrequent_dispatch, full_asset_schedule_control, limited_pause, vpp_limited_control

Example:

"limited_pause"

Response

200

application/json

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"