---
title: "OpenImmo-Datei importieren"
url: "https://maklerportal.apim.eu/apis/objektverwaltung/versions/725feb93-ed74-4ebf-862d-00afd038d14d/operations/openimmoImportieren"
---

> Full API specification: https://maklerportal.apim.eu/apis/objektverwaltung/versions/725feb93-ed74-4ebf-862d-00afd038d14d.md

# OpenImmo-Datei importieren

`POST` `/import/openimmo`

Operation ID: `openimmoImportieren`

Nimmt eine OpenImmo-XML-Datei oder ein ZIP mit Bildern entgegen und legt die enthaltenen Objekte an bzw. aktualisiert sie. Der Import läuft asynchron.

## Request body (required)

Content types: `multipart/form-data`

## Responses

- `202` - Import angenommen

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Objektverwaltung
  version: 1.0.0
servers:
  - url: https://api.maklerportal.example/v1
    description: Produktion
  - url: https://sandbox.api.maklerportal.example/v1
    description: Sandbox
paths:
  /import/openimmo:
    post:
      tags:
        - Import
      summary: OpenImmo-Datei importieren
      description: >
        Nimmt eine OpenImmo-XML-Datei oder ein ZIP mit Bildern entgegen und legt
        die

        enthaltenen Objekte an bzw. aktualisiert sie. Der Import läuft
        asynchron.
      operationId: openimmoImportieren
      security:
        - apiKey: []
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - datei
              properties:
                datei:
                  type: string
                  format: binary
                modus:
                  type: string
                  enum:
                    - ergaenzen
                    - ersetzen
                  default: ergaenzen
                  description: "`ersetzen` archiviert Objekte, die nicht in der Datei stehen."
      responses:
        "202":
          description: Import angenommen
          content:
            application/json:
              schema:
                type: object
                properties:
                  import_id:
                    type: string
                    example: imp_2f71
                  status:
                    type: string
                    enum:
                      - in_arbeit
                      - fertig
                      - fehlgeschlagen
                  objekte_erkannt:
                    type: integer
                    example: 47
security:
  - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: >
        Jeder Aufruf trägt einen API-Schlüssel im Header `apikey`. Den Schlüssel

        erzeugen Sie im Maklerportal unter "Meine Anwendungen"; er wird genau
        einmal

        angezeigt.


        An jedem Schlüssel hängen die Scopes, die er nutzen darf. Fehlt einer,

        antwortet die API mit `403` und `code: "scope_fehlt"`; der fehlende
        Scope

        steht in `details[].feld`.
```