Skip to Content
Uptimeify Docs

Kunden erstellen

Erstellt einen neuen Kunden und weist über packageType ein organisationsdefiniertes Paket zu.

POST /api/customers

Authentifizierung

Dieser Endpoint erfordert Authentifizierung.

BASE_URL="https://uptimeify.io"
TOKEN="wsm_<dein-api-token>"

Anfrage (Request Body)

{
  "name": "Kundenname",
  "email": "kunde@deinkunde.com",
  "packageType": "business", // konfigurierter packageType oder Display-Name aus der Paket-Konfiguration der Organisation
  "organizationId": 1, // optional (nur für Global Admins erforderlich)
  "status": "active", // optional, Standard: active
  "monthlyReportsEnabled": true, // optional, Standard ist monthlyReportsDefault des Pakets
  "companyName": "Nordwind ApS",
  "emailLanguage": "en", // optional: de, en oder da; Standard: wie die Organisation
  "customFields": { ... } // optional
}

Hinweise:

  • packageType kann den konfigurierten Paket-Key oder den Display-Namen des Pakets enthalten. Bekannte Alias-Schreibweisen wie aquisition_test werden automatisch normalisiert.
  • monthlyReportsEnabled ist optional. Ohne Angabe übernimmt der neue Kunde den Wert monthlyReportsDefault des zugewiesenen Pakets (siehe Paket-Konfiguration erstellen/aktualisieren); existiert für dieses Paket keine Konfiguration in der Organisation, gilt true. Ein ausdrücklich gesendeter Wert gewinnt immer, allein das Kundenfeld entscheidet, ob ein Bericht versendet wird.
  • companyName ist optional: der Firmenname des Kunden, auf der Kundenseite als „Firma“ angezeigt. Leer oder null leert ihn.
  • emailLanguage ist optional: de, en oder da, die Sprache der E-Mails und SMS an diesen Kunden (Alarme, Berichte, Statusseiten). Ohne Angabe oder mit null gilt die Sprache der Organisation. Jeder andere Wert wird mit 400 abgelehnt. Später änderbar über Kunde aktualisieren.
  • Wenn kein konfiguriertes Paket dazu passt, wird der Request mit 400 Bad Request abgelehnt.
  • notificationPhoneNumber ist optional: die Nummer, an die Alarm-SMS für diesen Kunden gehen. Sie muss im internationalen Format stehen (+ und Ländervorwahl) und aus EU/EWR, Schweiz oder Vereinigtem Königreich stammen, sonst wird der Request mit 400 Bad Request abgelehnt (data.code: smsCountryNotAllowed).
  • Für normale Benutzer wird organizationId aus der Session/dem Token abgeleitet und darf nicht überschrieben werden.
  • Für Global Admins muss organizationId explizit angegeben werden.
  • Das Anlegen eines Kunden ist ein organisationsweiter Vorgang: Er erfordert einen uneingeschränkten Kunden-Scope, nicht nur eine Rolle. readonly-Benutzer, editor-Benutzer mit Zuweisung zu bestimmten Kunden und Customer-Scoped Tokens erhalten 403 mit data.code: customerScopedTokenForbidden (siehe Rollen und der Kunden-Scope). Organisationsweite Editoren und Admins dürfen Kunden anlegen.

Ownership- & Berechtigungs-Overrides (optional)

Diese Felder steuern die Managed-vs.-Self-Service-Berechtigungen des Kunden und die Kanal-Typ-Policy. Sie sind org-write-gated: Nur Organisations-Admins (oder Global-Admins) können sie setzen. Werte eines Nicht-Admin-Aufrufers werden ignoriert, es gelten die Schema-Standards.

null (oder das Weglassen des Felds) bedeutet von der Paket-Konfiguration des Kunden erben.

FeldTypStandardBeschreibung
allowSelfServiceboolean|nullnull (erben)Ob der Kunde self_service-Monitore anlegen und verwalten darf
maxSelfServiceUrlsnumber|nullnull (erben)Obergrenze für die Gesamtzahl der self_service-Monitore des Kunden über alle Monitor-Typen
canEditManagedbooleanfalseAusnahme: erlaubt diesem Kunden, managed-Monitore zu bearbeiten (Klassen-Wechsel bleiben org-only). Vergaben werden ins Audit-Log geschrieben.
enableEmailAlertsboolean|nullnull (erben)Ob die E-Mail-Kanäle deiner Organisation zu diesem Kunden alarmieren (null = wie das Paket). Kanäle, die der Kunde selbst anlegt, bleiben immer unberührt
enableSmsAlertsboolean|nullnull (erben)Ob die SMS-Kanäle deiner Organisation zu diesem Kunden alarmieren (null = wie das Paket). Kanäle, die der Kunde selbst anlegt, bleiben immer unberührt
enableWebhookAlertsboolean|nullnull (erben)Ob die Webhooks-Kanäle deiner Organisation zu diesem Kunden alarmieren (null = wie das Paket). Kanäle, die der Kunde selbst anlegt, bleiben immer unberührt
enableIntegrationAlertsboolean|nullnull (erben)Ob die Integrationen-Kanäle deiner Organisation zu diesem Kunden alarmieren (null = wie das Paket). Kanäle, die der Kunde selbst anlegt, bleiben immer unberührt
enablePostRequestEscalationboolean|nullnull (erben)Kanal-Typ-Policy-Override: POST-Request-Eskalation

Der Legacy-notificationChannels-JSONB-Override ist deprecated: Die Kanal-Typ-Policy liegt in den enable*-Feldern oben.

Response

{
  "success": true,
  "customer": {
    "id": 64,
    "publicId": "6d74c32b-a97c-49b9-be3e-2b5e24bed826",
    "organizationId": 2,
    "name": "Example Customer",
    "email": "example@deinkunde.com",
    "notificationPhoneNumber": null,
    "notificationEmail": null,
    "packageId": 7,
    "packageType": "essential",
    "status": "active",
    "allowedCheckCountryCodes": null,
    "cancellationDate": null,
    "cancelledAt": null,
    "customFields": {
      "region": "EU",
      "planOwner": "Operations"
    },
    "monthlyReportsEnabled": true,
    "companyName": "Nordwind ApS",
    "emailLanguage": "en",
    "notificationChannels": null,
    "notificationTargets": null,
    "notificationRules": null,
    "smsUsageCurrentMonth": 0,
    "createdAt": "2026-04-04T12:27:13.415Z",
    "updatedAt": "2026-04-04T12:27:13.415Z"
  }
}

Auf dieser Seite