AXaxle
3. Sites

Offboard Site And Assets

Changed on

Offboard a site and all its associated assets in a single operation.

Unenrols from every proposition, and deletes the site and assets in accordance with data retention policies.

Use when the user is leaving entirely — for example, they've moved house, or your support team is removing them. Payments can no longer be accessed afterwards.

If the user is only opting out of one proposition (e.g. toggling Flex Lite off in your app), use unenrol instead — it preserves the site and any other propositions they're enrolled in.

post/entities/site/{site_id}/offboard-site-and-assets

Request

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

Path parameters

site_idstring uuid required

Response

Successfully offboarded site and asset

Changes

  • b0b07b1dbf12Revision changes
    • warning

      added the new price_curve enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status