> ## Documentation Index
> Fetch the complete documentation index at: https://docs.axle.energy/llms.txt
> Use this file to discover all available pages before exploring further.

# Enrol site

> Enrol a site in a proposition.

This is the commitment point — it activates the proposition for the site.

Idempotent: if the site is already enrolled, returns `already_enrolled` without making changes.

If the site previously withdrew from this proposition, returns 422. Set `override_withdrawal` to true to re-enrol.



## OpenAPI

````yaml POST /entities/site/{site_id}/enrol
openapi: 3.1.0
info:
  title: Axle API Docs
  description: >-
    For full documentation please see our official docs at <a
    href='http://docs.axle.energy'>docs.axle.energy</a>
  version: 1.4.6
servers:
  - url: https://api-sandbox.axle.energy
security: []
tags:
  - name: 1. Authentication
    description: Authenticate yourself with the Axle API
  - name: 2. Meters
    description: Find key info about your sites
  - name: 3. Sites
    description: Register your sites with Axle; configure market participation
  - name: 4. Assets
    description: Register your assets with Axle
  - name: 5. Data
    description: Send asset metrics to Axle, for analysis and optimisation purposes
  - name: 6. Rewards
    description: >-
      Determine how much your users have earned by participating with Axle;
      allow balance withdrawal
  - name: 7. Validation
    description: Validate structured data against Axle's rules
  - name: 8. Examples
    description: Get example data for testing
paths:
  /entities/site/{site_id}/enrol:
    post:
      tags:
        - 3. Sites
      summary: Enrol Site
      description: >-
        Enrol a site in a proposition.


        This is the commitment point — it activates the proposition for the
        site.


        Idempotent: if the site is already enrolled, returns `already_enrolled`
        without making changes.


        If the site previously withdrew from this proposition, returns 422. Set
        `override_withdrawal` to true to re-enrol.
      operationId: enrol_site_entities_site__site_id__enrol_post
      parameters:
        - required: true
          schema:
            type: string
            format: uuid
            title: Site Id
          name: site_id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrolRequest'
        required: true
      responses:
        '200':
          description: Successfully enrolled or already enrolled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrolResponse'
        '404':
          description: Site not found or not authorized
        '422':
          description: Eligibility prerequisites not met or previously withdrew consent
        '500':
          description: Internal server error
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    EnrolRequest:
      properties:
        proposition:
          type: string
          enum:
            - limited_pause
            - full_asset_schedule_control
          title: Proposition
          description: Proposition to enrol for
        override_withdrawal:
          type: boolean
          title: Override Withdrawal
          description: >-
            Set to true to re-enrol regardless of previous withdrawals. If this
            is a user-initated action, overriding previous withdrawals is
            recommended.
          default: false
          examples:
            - false
        gave_boundary_meter_consent_at:
          type: string
          format: date-time
          title: Gave Boundary Meter Consent At
          description: >-
            Optional timezone-aware ISO 8601 timestamp recording when the
            household gave boundary meter consent. If provided, overwrites any
            existing meter consent timestamp on the site.
      type: object
      required:
        - proposition
      title: EnrolRequest
      description: Request model for enrolling a site in a proposition.
    EnrolResponse:
      properties:
        site_id:
          type: string
          format: uuid
          title: Site Id
          description: ID of the enrolled site
          examples:
            - a1b2c3d4-e5f6-7890-abcd-ef1234567890
        status:
          type: string
          enum:
            - enrolled
            - already_enrolled
          title: Status
          description: >-
            Outcome of the enrolment attempt. Both `enrolled` and
            `already_enrolled` indicate success.
          examples:
            - enrolled
      type: object
      required:
        - site_id
        - status
      title: EnrolResponse
      description: Outcome of an enrolment attempt.
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: auth/token-form

````