userAPI-Referenz

POST/v2/user/{id}/batch_import

Kunden und optional Buchungen importieren

Importiert höchstens 50 Kunden mit email, first_name und last_name. import_location=users_table importiert Stammdaten; offer benötigt zusätzlich offer_id, pricecategory_id und import_location_in_offer (booking, waiting_list oder offerlist-ID). handle_duplicate_users steuert Ergänzen, Überschreiben oder Neuanlegen; ausser bei ignore_existing sind duplicate_id und handle_duplicate_user_bookings nötig. send_emails muss ein JSON-Boolean sein und kann einen Versandauftrag anlegen. Für Anfrage-Listen werden Angebot und aktive Preiskategorie geprüft; Lektionenangebote unterstützen diesen Listenimport nicht.

Operation-ID post_v2_user_id_batch_import

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource: user · user
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Pfadparameter

iderforderlich

Dieser Alias wertet den Pfadwert nicht als Kunden-ID aus; bevorzugt /user/batch/batch_import verwenden.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Beispiel

"batch"

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data object erforderlich

import_location string erforderlich

Erlaubte Werte

"offer""users_table"

handle_duplicate_users string erforderlich

Erlaubte Werte

"extend_existing""overwrite""ignore_existing"

send_emails boolean erforderlich

users array erforderlich

minItems: 1
maxItems: 50

Array-Elemente

object

Weitere Kundenfelder entsprechend dem User-Schema, einschliesslich data_1 bis data_30; kein accountabhängiges Feld wird zusätzlich als Pflichtfeld erfunden.

email Typ nicht eingeschränkt erforderlich

E-Mail-Feld muss vorhanden und nicht null sein; normale Kundenvalidierung/Normalisierung gilt.

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string"
}

first_name Typ nicht eingeschränkt erforderlich

Pflichtfeld nach Feldvorhandensein; allgemeine Kunden-Normalisierung gilt.

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string"
}

last_name Typ nicht eingeschränkt erforderlich

Pflichtfeld nach Feldvorhandensein; allgemeine Kunden-Normalisierung gilt.

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string"
}

id string

Öffentliche v2-ID aus dem ausgewählten Konto.

pattern: "^user_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"user_012345abcdef_123456"

country string

Öffentliche v2-ID aus dem ausgewählten Konto.

pattern: "^country_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"country_012345abcdef_123456"

language string

gender string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

offer_id string

Öffentliche v2-ID aus dem ausgewählten Konto.

pattern: "^offer_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"offer_012345abcdef_123456"

pricecategory_id string

Öffentliche v2-ID aus dem ausgewählten Konto.

pattern: "^pricecategory_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"pricecategory_012345abcdef_123456"

import_location_in_offer Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 Typ nicht eingeschränkt

Erlaubte Werte

"booking""waiting_list"

Variante 2 string

Öffentliche v2-ID aus dem ausgewählten Konto.

pattern: "^offerlist_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"offerlist_012345abcdef_123456"

duplicate_id string

Erlaubte Werte

"user_id""email"

handle_duplicate_user_bookings string

Erlaubte Werte

"ignore""add_additional_booking"

allOf · Alle Teilschemas müssen gemeinsam passen

Variante 1 Typ nicht eingeschränkt

Schema-Regel if

Typ nicht eingeschränkt

import_location Typ nicht eingeschränkt erforderlich

Fester Wert: "offer"

Schema-Regel then

Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: offer_id, pricecategory_id, import_location_in_offer

Variante 2 Typ nicht eingeschränkt

Schema-Regel if

Typ nicht eingeschränkt

handle_duplicate_users Typ nicht eingeschränkt erforderlich

Erlaubte Werte

"extend_existing""overwrite"

Schema-Regel then

Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: duplicate_id, handle_duplicate_user_bookings

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "import_location": {
          "type": "string",
          "enum": [
            "offer",
            "users_table"
          ]
        },
        "handle_duplicate_users": {
          "type": "string",
          "enum": [
            "extend_existing",
            "overwrite",
            "ignore_existing"
          ]
        },
        "send_emails": {
          "type": "boolean"
        },
        "users": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "email": {
                "x-edoobox-canonicalType": "string",
                "description": "E-Mail-Feld muss vorhanden und nicht null sein; normale Kundenvalidierung/Normalisierung gilt."
              },
              "first_name": {
                "x-edoobox-canonicalType": "string",
                "description": "Pflichtfeld nach Feldvorhandensein; allgemeine Kunden-Normalisierung gilt."
              },
              "last_name": {
                "x-edoobox-canonicalType": "string",
                "description": "Pflichtfeld nach Feldvorhandensein; allgemeine Kunden-Normalisierung gilt."
              },
              "id": {
                "type": "string",
                "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "user_012345abcdef_123456"
                ],
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
              },
              "country": {
                "type": "string",
                "pattern": "^country_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "country_012345abcdef_123456"
                ],
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
              },
              "language": {
                "type": "string"
              },
              "gender": {
                "type": "string"
              }
            },
            "additionalProperties": true,
            "required": [
              "email",
              "first_name",
              "last_name"
            ],
            "description": "Weitere Kundenfelder entsprechend dem User-Schema, einschliesslich data_1 bis data_30; kein accountabhängiges Feld wird zusätzlich als Pflichtfeld erfunden."
          },
          "minItems": 1,
          "maxItems": 50
        },
        "offer_id": {
          "type": "string",
          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
          "examples": [
            "offer_012345abcdef_123456"
          ],
          "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
        },
        "pricecategory_id": {
          "type": "string",
          "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$",
          "examples": [
            "pricecategory_012345abcdef_123456"
          ],
          "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
        },
        "import_location_in_offer": {
          "anyOf": [
            {
              "enum": [
                "booking",
                "waiting_list"
              ]
            },
            {
              "type": "string",
              "pattern": "^offerlist_[a-f0-9]{12}_-?[0-9]+$",
              "examples": [
                "offerlist_012345abcdef_123456"
              ],
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
            }
          ]
        },
        "duplicate_id": {
          "type": "string",
          "enum": [
            "user_id",
            "email"
          ]
        },
        "handle_duplicate_user_bookings": {
          "type": "string",
          "enum": [
            "ignore",
            "add_additional_booking"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "import_location",
        "handle_duplicate_users",
        "send_emails",
        "users"
      ],
      "allOf": [
        {
          "if": {
            "properties": {
              "import_location": {
                "const": "offer"
              }
            },
            "required": [
              "import_location"
            ]
          },
          "then": {
            "required": [
              "offer_id",
              "pricecategory_id",
              "import_location_in_offer"
            ]
          }
        },
        {
          "if": {
            "properties": {
              "handle_duplicate_users": {
                "enum": [
                  "extend_existing",
                  "overwrite"
                ]
              }
            },
            "required": [
              "handle_duplicate_users"
            ]
          },
          "then": {
            "required": [
              "duplicate_id",
              "handle_duplicate_user_bookings"
            ]
          }
        }
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Kunden und optional Buchungen importieren

{
  "data": {
    "import_location": "users_table",
    "handle_duplicate_users": "ignore_existing",
    "send_emails": false,
    "users": [
      {
        "email": "alex@example.invalid",
        "first_name": "Alex",
        "last_name": "Beispiel"
      }
    ]
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data.ids enthält erstellte beziehungsweise nachgeführte Kunden-IDs; data.insert=true meldet den abgeschlossenen Import. Ein Versandauftrag wird gegebenenfalls zusätzlich erstellt.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data object

ids array

Array-Elemente

string

Öffentliche v2-ID aus dem ausgewählten Konto.

pattern: "^user_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"user_012345abcdef_123456"

insert boolean

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "ids": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
            "examples": [
              "user_012345abcdef_123456"
            ],
            "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
          }
        },
        "insert": {
          "type": "boolean"
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "ids": [
      "user_012345abcdef_123456"
    ],
    "insert": true
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/User.php:370postUser()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/02-booking-users.json",
  "notes": [
    "Für einen reinen Stammdatenimport verwendet das Beispiel send_emails=false. Versand und Buchungsfolgen benötigen einen passenden Angebotskontext und werden nativ geprüft."
  ]
}

x-edoobox-source

{
  "file": "application/models/v2/User.php",
  "method": "postUser",
  "line": 370,
  "branch": {
    "file": "application/models/v2/User.php",
    "line": 390
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "user",
  "short": "user",
  "checkedByDispatcher": true,
  "levels": [
    2,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_user_id_batch_import",
  "summary": "Kunden und optional Buchungen importieren",
  "description": "Importiert höchstens 50 Kunden mit email, first_name und last_name. import_location=users_table importiert Stammdaten; offer benötigt zusätzlich offer_id, pricecategory_id und import_location_in_offer (booking, waiting_list oder offerlist-ID). handle_duplicate_users steuert Ergänzen, Überschreiben oder Neuanlegen; ausser bei ignore_existing sind duplicate_id und handle_duplicate_user_bookings nötig. send_emails muss ein JSON-Boolean sein und kann einen Versandauftrag anlegen. Für Anfrage-Listen werden Angebot und aktive Preiskategorie geprüft; Lektionenangebote unterstützen diesen Listenimport nicht.",
  "tags": [
    "user"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "Dieser Alias wertet den Pfadwert nicht als Kunden-ID aus; bevorzugt /user/batch/batch_import verwenden.",
      "schema": {
        "type": "string"
      },
      "example": "batch"
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "data.ids enthält erstellte beziehungsweise nachgeführte Kunden-IDs; data.insert=true meldet den abgeschlossenen Import. Ein Versandauftrag wird gegebenenfalls zusätzlich erstellt.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "ids": [
                "user_012345abcdef_123456"
              ],
              "insert": true
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                      "examples": [
                        "user_012345abcdef_123456"
                      ],
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                    }
                  },
                  "insert": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "import_location": {
                  "type": "string",
                  "enum": [
                    "offer",
                    "users_table"
                  ]
                },
                "handle_duplicate_users": {
                  "type": "string",
                  "enum": [
                    "extend_existing",
                    "overwrite",
                    "ignore_existing"
                  ]
                },
                "send_emails": {
                  "type": "boolean"
                },
                "users": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "email": {
                        "x-edoobox-canonicalType": "string",
                        "description": "E-Mail-Feld muss vorhanden und nicht null sein; normale Kundenvalidierung/Normalisierung gilt."
                      },
                      "first_name": {
                        "x-edoobox-canonicalType": "string",
                        "description": "Pflichtfeld nach Feldvorhandensein; allgemeine Kunden-Normalisierung gilt."
                      },
                      "last_name": {
                        "x-edoobox-canonicalType": "string",
                        "description": "Pflichtfeld nach Feldvorhandensein; allgemeine Kunden-Normalisierung gilt."
                      },
                      "id": {
                        "type": "string",
                        "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                        "examples": [
                          "user_012345abcdef_123456"
                        ],
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                      },
                      "country": {
                        "type": "string",
                        "pattern": "^country_[a-f0-9]{12}_-?[0-9]+$",
                        "examples": [
                          "country_012345abcdef_123456"
                        ],
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                      },
                      "language": {
                        "type": "string"
                      },
                      "gender": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "email",
                      "first_name",
                      "last_name"
                    ],
                    "description": "Weitere Kundenfelder entsprechend dem User-Schema, einschliesslich data_1 bis data_30; kein accountabhängiges Feld wird zusätzlich als Pflichtfeld erfunden."
                  },
                  "minItems": 1,
                  "maxItems": 50
                },
                "offer_id": {
                  "type": "string",
                  "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                  "examples": [
                    "offer_012345abcdef_123456"
                  ],
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                },
                "pricecategory_id": {
                  "type": "string",
                  "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$",
                  "examples": [
                    "pricecategory_012345abcdef_123456"
                  ],
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                },
                "import_location_in_offer": {
                  "anyOf": [
                    {
                      "enum": [
                        "booking",
                        "waiting_list"
                      ]
                    },
                    {
                      "type": "string",
                      "pattern": "^offerlist_[a-f0-9]{12}_-?[0-9]+$",
                      "examples": [
                        "offerlist_012345abcdef_123456"
                      ],
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                    }
                  ]
                },
                "duplicate_id": {
                  "type": "string",
                  "enum": [
                    "user_id",
                    "email"
                  ]
                },
                "handle_duplicate_user_bookings": {
                  "type": "string",
                  "enum": [
                    "ignore",
                    "add_additional_booking"
                  ]
                }
              },
              "additionalProperties": true,
              "required": [
                "import_location",
                "handle_duplicate_users",
                "send_emails",
                "users"
              ],
              "allOf": [
                {
                  "if": {
                    "properties": {
                      "import_location": {
                        "const": "offer"
                      }
                    },
                    "required": [
                      "import_location"
                    ]
                  },
                  "then": {
                    "required": [
                      "offer_id",
                      "pricecategory_id",
                      "import_location_in_offer"
                    ]
                  }
                },
                {
                  "if": {
                    "properties": {
                      "handle_duplicate_users": {
                        "enum": [
                          "extend_existing",
                          "overwrite"
                        ]
                      }
                    },
                    "required": [
                      "handle_duplicate_users"
                    ]
                  },
                  "then": {
                    "required": [
                      "duplicate_id",
                      "handle_duplicate_user_bookings"
                    ]
                  }
                }
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Kunden und optional Buchungen importieren",
            "value": {
              "data": {
                "import_location": "users_table",
                "handle_duplicate_users": "ignore_existing",
                "send_emails": false,
                "users": [
                  {
                    "email": "alex@example.invalid",
                    "first_name": "Alex",
                    "last_name": "Beispiel"
                  }
                ]
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/02-booking-users.json",
    "notes": [
      "Für einen reinen Stammdatenimport verwendet das Beispiel send_emails=false. Versand und Buchungsfolgen benötigen einen passenden Angebotskontext und werden nativ geprüft."
    ]
  },
  "x-edoobox-source": {
    "file": "application/models/v2/User.php",
    "method": "postUser",
    "line": 370,
    "branch": {
      "file": "application/models/v2/User.php",
      "line": 390
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "user",
    "short": "user",
    "checkedByDispatcher": true,
    "levels": [
      2,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_ID:?PATH_ID setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "import_location": "users_table",
    "handle_duplicate_users": "ignore_existing",
    "send_emails": false,
    "users": [
      {
        "email": "alex@example.invalid",
        "first_name": "Alex",
        "last_name": "Beispiel"
      }
    ]
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/user/'"${PATH_ID}"'/batch_import' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/user/{id}/batch_import";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "import_location": "users_table",
    "handle_duplicate_users": "ignore_existing",
    "send_emails": false,
    "users": [
      {
        "email": "alex@example.invalid",
        "first_name": "Alex",
        "last_name": "Beispiel"
      }
    ]
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/user/{id}/batch_import"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"import_location\":\"users_table\",\"handle_duplicate_users\":\"ignore_existing\",\"send_emails\":false,\"users\":[{\"email\":\"alex@example.invalid\",\"first_name\":\"Alex\",\"last_name\":\"Beispiel\"}]}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/user/{id}/batch_import";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "import_location": "users_table",
    "handle_duplicate_users": "ignore_existing",
    "send_emails": false,
    "users": [
      {
        "email": "alex@example.invalid",
        "first_name": "Alex",
        "last_name": "Beispiel"
      }
    ]
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/user/{id}/batch_import"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"import_location\":\"users_table\",\"handle_duplicate_users\":\"ignore_existing\",\"send_emails\":false,\"users\":[{\"email\":\"alex@example.invalid\",\"first_name\":\"Alex\",\"last_name\":\"Beispiel\"}]}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.