v1

latestOpenAPI 3.1.02026-07-264793109.1 KB
3. Sites

Offboard Site And Assets

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

Path parameters

site_idstring uuid required

Response

Successfully offboarded site and asset