InboxWarm API-Dokumentation

Referenzdokumentation für die REST API von InboxWarm. Verwenden Sie sie zusammen mit der InboxWarm API Postman-Sammlung.

Auf dieser Seite

Basis-URL Authentifizierung Ratenbegrenzungen Fehler Endpunkt-Index

System

GETZustandsprüfung GETStatus der Ratenbegrenzung

E-Mail-Konten

GETE-Mail-Konten auflisten POSTE-Mail-Konto verbinden POSTE-Mail-Konten in großen Mengen verbinden POSTE-Mail-Konto trennen DELETEE-Mail-Konto löschen POSTE-Mail-Konten in großen Mengen löschen GETE-Mail-Konto-Status abrufen POSTE-Mail-Konto-Status in großen Mengen

Aufwärmen

GETAufwärmeinstellungen abrufen PATCHAufwärmeinstellungen aktualisieren GETAufwärmsprachen auflisten GETAufwärmbranchen auflisten POSTAufwärmen starten POSTAufwärmen stoppen POSTAufwärmaktion in großen Mengen POSTAufwärmeinstellungen in großen Mengen aktualisieren GETAufwärmaktivitätsverlauf

Zustellbarkeit

GETEinrichtungsbewertung abrufen POSTEinrichtungsbewertung aktualisieren GETDNS-Zustandsprüfung POSTZustellbarkeitsbewertung abrufen

Berichte

GETDashboard POSTEinzelkontobericht POSTMassenbericht POSTBericht exportieren

https://app.inboxwarm.ai/api/v1

InboxWarm verwendet je nach HTTP-Methode ein gemischtes Authentifizierungsschema:

GET

GET- und DELETE-Anfragen — senden Sie Ihren API-Schlüssel als api_key Abfrageparameter.

POST

POST- und PATCH-Anfragen — senden Sie Ihren API-Schlüssel als apiKey Feld im JSON-Body.

Erstellen und verwalten Sie Schlüssel über Developer kit > API Integration in der InboxWarm-App. Jeder Schlüssel gewährt vollständigen Kontozugriff über alle unten aufgeführten Endpunkte.

Beispiel — GET-Anfrage:

GET https://app.inboxwarm.ai/api/v1/email-accounts?api_key=YOUR_API_KEY

Beispiel — POST-Anfrage-Body:

{
  "apiKey": "YOUR_API_KEY",
  ...
}

Das Standardlimit beträgt 20 Anfragen/Minute pro API-Schlüssel. Überprüfen Sie die aktuelle Nutzung jederzeit über GET /rate-limit — dieser Aufruf wird nicht auf Ihr Kontingent angerechnet.

Fehler folgen einer einheitlichen Struktur:

{
  "error_code": "validation_error",
  "message": "One or more fields are invalid.",
  "details": {}
}

Häufige error_code-Werte: validation_error (400), not_found (404), conflict (409), unprocessable (422).

System

GET/healthZustandsprüfung GET/rate-limitStatus der Ratenbegrenzung

E-Mail-Konten

GET/email-accountsE-Mail-Konten auflisten POST/email-accountsE-Mail-Konto verbinden POST/email-accounts/bulk-connectE-Mail-Konten in großen Mengen verbinden POST/email-accounts/{emailAccountId}/disconnectE-Mail-Konto trennen DELETE/email-accounts/{emailAccountId}E-Mail-Konto löschen POST/email-accounts/bulk-deleteE-Mail-Konten in großen Mengen löschen GET/email-accounts/{emailAccountId}/statusE-Mail-Konto-Status abrufen POST/email-accounts/bulk-statusE-Mail-Konto-Status in großen Mengen

Aufwärmen

GET/warmup-settings/{emailAccountId}Aufwärmeinstellungen abrufen PATCH/warmup-settings/{emailAccountId}Aufwärmeinstellungen aktualisieren GET/warmup-settings/languagesAufwärmsprachen auflisten GET/warmup-settings/industriesAufwärmbranchen auflisten POST/warmup-settings/{emailAccountId}/startAufwärmen starten POST/warmup-settings/{emailAccountId}/stopAufwärmen stoppen POST/warmup-settings/bulk-actionAufwärmaktion in großen Mengen POST/warmup-settings/bulk-updateAufwärmeinstellungen in großen Mengen aktualisieren GET/warmup-status/{emailAccountId}Aufwärmaktivitätsverlauf

Zustellbarkeit

GET/setup-score/{emailAccountId}Einrichtungsbewertung abrufen POST/setup-score/{emailAccountId}/refreshEinrichtungsbewertung aktualisieren GET/dns-health/{emailAccountId}DNS-Zustandsprüfung POST/deliverability-score/{emailAccountId}Zustellbarkeitsbewertung abrufen

Berichte

GET/dashboardDashboard POST/reportsEinzelkontobericht POST/reports/bulkMassenbericht POST/reports/exportBericht exportieren

GEThttps://app.inboxwarm.ai/api/v1/health

Grundlegende Verfügbarkeitsprüfung für die API.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "status": "ok"
}

GEThttps://app.inboxwarm.ai/api/v1/rate-limit

Überprüfen Sie den aktuellen Verbrauch der Ratenbegrenzung, ohne eine Anfrage auf Ihr Kontingent anzurechnen.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "limit": 20,
  "remaining": 18,
  "reset": 1752585600
}

GEThttps://app.inboxwarm.ai/api/v1/email-accounts

Listet verbundene E-Mail-Konten mit ihrem aktuellen Status auf. Unterstützt Suche, Seitennummerierung und Sortierung. Verwenden Sie die Suche, um die emailAccountId für eine Adresse nachzuschlagen, falls Sie sie jemals erneut auflösen müssen.

Authentifizierung:Abfrageparameterapi_key

Abfrageparameter

searchSuche nach E-Mail-Adresse oder Name

statusactive | warming | paused | error | auth-expired

sort

sortBy

Antworten

{
  "items": [
    {
      "id": "12345",
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "status": "warming",
      "createdAt": "2026-06-01T10:00:00.000Z"
    },
    {
      "id": "12346",
      "fromEmail": "sales@yourcompany.com",
      "fromName": "Sales Team",
      "type": "microsoft",
      "status": "active",
      "createdAt": "2026-06-03T14:20:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

POSThttps://app.inboxwarm.ai/api/v1/email-accounts

Verbinden Sie ein Gmail-, Microsoft- oder SMTP/IMAP-Konto mit SMTP/IMAP-Anmeldedaten (für Gmail und Microsoft funktioniert ein App-Passwort). Speichern Sie die zurückgegebene emailAccountId — jeder andere Endpunkt ist darüber referenziert.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "fromEmail": "john@yourcompany.com",
  "fromName": "John Doe",
  "type": "gmail",
  "smtp": {
    "host": "smtp.example.com",
    "port": 587,
    "password": "your-password",
    "encryption": "TLS",
    "userName": "smtp-username"
  },
  "imap": {
    "host": "imap.example.com",
    "port": 993,
    "encryption": "SSL",
    "userName": "imap-username"
  }
}

Antworten

{
  "emailAccountId": "12345",
  "fromEmail": "john@yourcompany.com",
  "fromName": "John Doe",
  "type": "gmail",
  "status": "active"
}

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-connect

Verbinden Sie bis zu 20 Konten in einem Aufruf. Jeder Eintrag wird unabhängig validiert und verbunden — ein fehlerhaftes oder doppeltes Konto stoppt die anderen nicht —, und die Antwort meldet Erfolg oder Fehlschlag pro Konto, in derselben Reihenfolge wie die Eingabe.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "emailAccounts": [
    {
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "smtp": { "host": "smtp.example.com", "port": 587, "password": "your-password", "encryption": "TLS", "userName": "smtp-username" },
      "imap": { "host": "imap.example.com", "port": 993, "encryption": "SSL", "userName": "imap-username" }
    },
    {
      "fromEmail": "sales@yourcompany.com",
      "type": "microsoft",
      "smtp": { "password": "app-specific-password" }
    }
  ]
}

Antworten

{
  "results": [
    {
      "success": true,
      "emailAccountId": "12345",
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "status": "active"
    },
    {
      "success": false,
      "fromEmail": "sales@yourcompany.com",
      "error_code": "already_connected",
      "message": "This email address is already connected.",
      "details": {}
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}/disconnect

Pausieren Sie ein Konto, ohne es zu löschen. Konfiguration und Verlauf bleiben für eine spätere Wiederverbindung erhalten.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}"
}

Antworten

{
  "emailAccountId": "12345",
  "status": "disconnected"
}

DELETEhttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}

Entfernen Sie ein Konto und alle zugehörigen Aufwärmdaten und den Verlauf dauerhaft.

Authentifizierung:Abfrageparameterapi_key

Antworten

Kein Antworttext

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-delete

Entfernen Sie bis zu 20 Konten in einem Aufruf dauerhaft.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ]
}

Antworten

{
  "results": [
    {
      "emailAccountId": "12345",
      "deleted": true
    },
    {
      "emailAccountId": "12346",
      "deleted": true
    }
  ]
}

GEThttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}/status

Detaillierter Status für ein einzelnes Konto — Verbindungszustand, Aufwärmstatus, Authentifizierungsstatus, aktive Fehler.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "emailAccountId": "12345",
  "fromEmail": "john@yourcompany.com",
  "type": "gmail",
  "authStatus": "connected",
  "warmupStatus": "active",
  "healthScore": 92,
  "connectionError": null,
  "lastConnectedAt": "2026-07-15T08:00:00.000Z"
}

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-status

Status für bis zu 50 Konten in einem Aufruf, zurückgegeben in derselben Reihenfolge wie die eingegebenen IDs.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ]
}

Antworten

{
  "results": [
    {
      "emailAccountId": "12345",
      "fromEmail": "john@yourcompany.com",
      "type": "gmail",
      "authStatus": "connected",
      "warmupStatus": "active",
      "healthScore": 92,
      "connectionError": null,
      "lastConnectedAt": "2026-07-15T08:00:00.000Z"
    },
    {
      "emailAccountId": "12346",
      "fromEmail": "sales@yourcompany.com",
      "type": "microsoft",
      "authStatus": "connected",
      "warmupStatus": "paused",
      "healthScore": 81,
      "connectionError": null,
      "lastConnectedAt": "2026-07-14T22:10:00.000Z"
    }
  ]
}

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}

Rufen Sie die aktuelle Aufwärmkonfiguration für ein Konto ab.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "emailAccountId": "12345",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

PATCHhttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}

Aktualisieren Sie eine oder mehrere Aufwärmeinstellungen für ein Konto — Absendername, Zeitzone, Sendeplan, Sprache, Branche oder Themen. Nur die von Ihnen gesendeten Felder werden geändert.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

Antworten

{
  "emailAccountId": "12345",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/languages

Listet alle Sprachen auf, in denen Aufwärminhalte erstellt werden können, damit Sie wissen, welche Werte warmupLanguage akzeptiert.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "languages": [
    { "code": "en", "name": "English", "nativeName": "English", "script": "Latin" },
    { "code": "es", "name": "Spanish", "nativeName": "Español", "script": "Latin" },
    { "code": "ja", "name": "Japanese", "nativeName": "日本語", "script": "Japanese" }
  ]
}

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/industries

Listet alle Zielbranchen und die dazugehörigen vorgeschlagenen Themen auf, damit Sie wissen, welche Werte targetIndustry und warmupTopics akzeptieren.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "industries": [
    {
      "key": "e_commerce",
      "name": "E-Commerce",
      "topics": [
        "Abandoned cart follow-up",
        "New product launch",
        "Seasonal sale announcement",
        "Order and shipping update",
        "Customer review request"
      ]
    },
    {
      "key": "saas_software",
      "name": "SaaS / Software",
      "topics": ["Feature announcement", "Onboarding tip", "Case study"]
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}/start

Starten Sie das Aufwärmen für ein Konto.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}"
}

Antworten

{
  "emailAccountId": "12345",
  "warmupStatus": "active"
}

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}/stop

Stoppen Sie das Aufwärmen für ein Konto.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}"
}

Antworten

{
  "emailAccountId": "12345",
  "warmupStatus": "paused"
}

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/bulk-action

Starten oder stoppen Sie das Aufwärmen für bis zu 50 Konten in einem Aufruf.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "action": "start"
}

Antworten

{
  "results": [
    {
      "emailAccountId": "12345",
      "status": "ok"
    },
    {
      "emailAccountId": "12346",
      "status": "ok"
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/bulk-update

Wenden Sie Zeitplan- und/oder Inhaltseinstellungen auf bis zu 50 Konten in einem Aufruf an.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "apply": ["language", "window"],
  "warmupLanguage": "es",
  "sendingWindowStartTime": "06:00",
  "sendingWindowEndTime": "10:00"
}

Antworten

{
  "updatedCount": 2
}

GEThttps://app.inboxwarm.ai/api/v1/warmup-status/{emailAccountId}

Heutige Aufwärmaktivität für ein Konto: gesendet, empfangen, beantwortet, Spam, unzustellbar.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "emailAccountId": "12345",
  "date": "2026-07-15",
  "current": "active",
  "dailySendingLimit": 10,
  "sent": 12,
  "received": 10,
  "replied": 7,
  "spam": 1,
  "bounced": 0
}

GEThttps://app.inboxwarm.ai/api/v1/setup-score/{emailAccountId}

Zwischengespeicherte Einrichtungs-Zustandsbewertung (DMARC-, SPF-, DKIM-, MX-, Blacklist-Prüfungen) für ein Konto.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "emailAccountId": "12345",
  "emailAccountScore": 86,
  "dmarcScore": 15,
  "spfScore": 29,
  "dkimScore": 18,
  "mxRecordScore": 9,
  "ipBlacklistScore": 5,
  "domainBlacklistScore": 10,
  "updatedAt": "2026-07-14T10:30:00.000Z",
  "manualLastRefreshedAt": "2026-07-14T10:30:00.000Z"
}

POSThttps://app.inboxwarm.ai/api/v1/setup-score/{emailAccountId}/refresh

Berechnen Sie die Einrichtungsbewertung für ein Konto synchron neu.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}"
}

Antworten

{
  "emailAccountId": "12345",
  "emailAccountScore": 88,
  "dmarcScore": 15,
  "spfScore": 29,
  "dkimScore": 18,
  "mxRecordScore": 9,
  "ipBlacklistScore": 7,
  "domainBlacklistScore": 10,
  "updatedAt": "2026-07-15T09:00:00.000Z",
  "manualLastRefreshedAt": "2026-07-15T09:00:00.000Z"
}

GEThttps://app.inboxwarm.ai/api/v1/dns-health/{emailAccountId}

Live-DNS-Abfrage für die sendende Domain des Kontos — bestanden/nicht bestanden für SPF, DKIM, DMARC, MX.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "emailAccountId": "12345",
  "spf": "pass",
  "dkim": "pass",
  "dmarc": "pass",
  "mx": "pass",
  "cachedAt": "2026-07-15T09:00:00.000Z"
}

POSThttps://app.inboxwarm.ai/api/v1/deliverability-score/{emailAccountId}

Gesamte und ESP-spezifische Posteingang-vs-Spam-Zustellrate für einen Datumsbereich.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "startDate": "2026-06-01",
  "endDate": "2026-06-30",
  "esps": [
    "gmail",
    "outlook",
    "other"
  ]
}

Antworten

{
  "emailAccountId": "12345",
  "totalDeliverabilityRate": 88,
  "totalSentCount": 1500,
  "totalInboxCount": 1320,
  "totalSpamInboxCount": 180,
  "gmail": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  },
  "outlook": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  },
  "other": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  }
}

GEThttps://app.inboxwarm.ai/api/v1/dashboard

Kontoweite Aufwärmzusammenfassung über alle verbundenen Posteingänge hinweg.

Authentifizierung:Abfrageparameterapi_key

Antworten

{
  "totalAccounts": 42,
  "activeWarmups": 30,
  "pausedWarmups": 8,
  "accountsWithErrors": 2,
  "avgSetupScore": 78.5
}

POSThttps://app.inboxwarm.ai/api/v1/reports

Täglicher Aufwärmbericht für ein Konto über einen Datumsbereich.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "emailAccountId": "12345",
  "from": "2026-06-01",
  "to": "2026-06-30"
}

Antworten

{
  "emailAccountId": "12345",
  "from": "2026-06-01",
  "to": "2026-06-30",
  "days": [
    {
      "date": "2026-06-15",
      "sent": 25,
      "inbox": 20,
      "received": 22,
      "spam": 3,
      "bounced": 1,
      "undelivered": 0,
      "replied": 5,
      "deliverabilityRate": 92.5
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/reports/bulk

Tägliche Aufwärmberichte für bis zu 50 Konten über einen Datumsbereich.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "from": "2026-06-01",
  "to": "2026-06-30"
}

Antworten

{
  "reports": [
    {
      "emailAccountId": "12345",
      "from": "2026-06-01",
      "to": "2026-06-30",
      "days": [
        {
          "date": "2026-06-15",
          "sent": 25,
          "inbox": 20,
          "received": 22,
          "spam": 3,
          "bounced": 1,
          "undelivered": 0,
          "replied": 5,
          "deliverabilityRate": 92.5
        }
      ]
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/reports/export

Starten Sie einen asynchronen CSV-Export von Aufwärmberichten, der bei Fertigstellung per E-Mail zugestellt wird.

Authentifizierung:Body-FeldapiKey

Anfrage-Body

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "from": "2026-06-01",
  "to": "2026-06-30"
}

Antworten

{
  "jobId": "a1b2c3d4",
  "status": "queued"
}

InboxWarm API-Dokumentation

Basis-URL#

Authentifizierung#

Ratenbegrenzungen#

Fehler#

Endpunkt-Index#

System

Zustandsprüfung#

Status der Ratenbegrenzung#

E-Mail-Konten

E-Mail-Konten auflisten#

E-Mail-Konto verbinden#

E-Mail-Konten in großen Mengen verbinden#

E-Mail-Konto trennen#

E-Mail-Konto löschen#

E-Mail-Konten in großen Mengen löschen#

E-Mail-Konto-Status abrufen#

E-Mail-Konto-Status in großen Mengen#

Aufwärmen

Aufwärmeinstellungen abrufen#

Aufwärmeinstellungen aktualisieren#

Aufwärmsprachen auflisten#

Aufwärmbranchen auflisten#

Aufwärmen starten#

Aufwärmen stoppen#

Aufwärmaktion in großen Mengen#

Aufwärmeinstellungen in großen Mengen aktualisieren#

Aufwärmaktivitätsverlauf#

Zustellbarkeit

Einrichtungsbewertung abrufen#

Einrichtungsbewertung aktualisieren#

DNS-Zustandsprüfung#

Zustellbarkeitsbewertung abrufen#

Berichte

Dashboard#

Einzelkontobericht#

Massenbericht#

Bericht exportieren#