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

# Exclude a partner from the automatic BRP process

> Exclude one market party from every automatic BRP step - e.g. an
exterritorial DSO connected to a foreign control block, where the
supplier delivers but no German BKV is needed. Idempotent: setting it
again updates the reason. Explicit manual sends stay possible.



## OpenAPI

````yaml /setup/internal-openapi.json put /v1/process/market-partners/{key}/ausnahme
openapi: 3.1.0
info:
  title: n:lead Scheduling Bridge — Internal API
  version: 0.4.0
  description: >-
    Internal API of the n:lead scheduling bridge: the process endpoints that
    drive the day-ahead pipeline (aggregate, publish the open position, submit
    schedules, generate forecasts, orchestrate) and the operator console
    endpoints. Requires the process API key; not for customer use.
servers:
  - url: >-
      https://nleadbridge-app.lemonisland-7d6503d3.germanywestcentral.azurecontainerapps.io
    description: Deployed service
  - url: http://localhost:8000
    description: Local development
security: []
paths:
  /v1/process/market-partners/{key}/ausnahme:
    put:
      summary: Exclude a partner from the automatic BRP process
      description: |-
        Exclude one market party from every automatic BRP step - e.g. an
        exterritorial DSO connected to a foreign control block, where the
        supplier delivers but no German BKV is needed. Idempotent: setting it
        again updates the reason. Explicit manual sends stay possible.
      operationId: put_ausnahme_v1_process_market_partners__key__ausnahme_put
      parameters:
        - name: key
          in: path
          required: true
          schema:
            type: string
            description: The partner's MP-ID, or one of its MGA EICs
            title: Key
          description: The partner's MP-ID, or one of its MGA EICs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AusnahmeRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AusnahmeResponse'
        '404':
          description: The key names no known market party.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    AusnahmeRequest:
      properties:
        reason:
          type: string
          maxLength: 500
          minLength: 3
          title: Reason
          description: >-
            Why the partner is excluded - shown in the overview row and the
            event log
      type: object
      required:
        - reason
      title: AusnahmeRequest
      description: |-
        Exclude one market party from the automatic BRP process.

        No Erstkontakt, Erinnerung, PARTIN/ZOE fan-out, auto-Zuordnung,
        PARTIN auto-answer or Korrektur mail ever targets an excluded
        partner. Explicit manual sends stay possible - the exclusion binds
        the automation, not the operator. Typical case: an exterritorial DSO
        connected to a foreign control block, where the supplier delivers
        but no German BRP is needed.
    AusnahmeResponse:
      properties:
        mp_id:
          type: string
          title: Mp Id
          description: The excluded partner's MP-ID
        name:
          type: string
          title: Name
          description: Partner name from the registry, may be empty
        reason:
          type: string
          title: Reason
        noted_at:
          type: string
          title: Noted At
      type: object
      required:
        - mp_id
        - name
        - reason
        - noted_at
      title: AusnahmeResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      description: OIDC access token (Auth0 M2M)
      scheme: bearer

````