Zum Hauptinhalt springen

Datenaustausch

Die mail2many API arbeitet mit JSON für den Datenaustausch. Alle Requests und Responses erfolgen im JSON‑Format.

Request​

Der Request‑Body muss als JSON gesendet werden. Welche Felder erforderlich sind und welche optional, ist in der Dokumentation des jeweiligen Endpoints beschrieben.

Wichtig: Die Beispiele in der Dokumentation enthalten normalerweise alle verfügbaren Felder. Überprüfe das Schema und sende nur die Felder, die du benötigst. Wenn ein Feld nullable ist, kannst du es weglassen.

Beispiel-Request:

{
  "email": "user@example.com",
  "firstname": "John",
  "lastname": "Doe",
  "genderId": 1,
  "sendOptIn": true
}

Response​

Die API antwortet mit einem HTTP‑Statuscode und normalerweise einem JSON‑Body. Die Antwort enthält typischerweise mehr Felder als dein Request, da mail2many alle Felder der Ressource sowie Meta‑Informationen wie ID oder Erstellungsdatum zurückgibt.

Beispiel‑Response:

HTTP/1.1 200 OK

{
  "id": 1,
  "email": "user@example.com",
  "status": 2,
  "statusAddition": 1,
  "genderId": 1,
  "languageIso": "de",
  "firstname": "John",
  "lastname": "Doe",
  "company": null,
  "street": null,
  "postcode": null,
  "city": null,
  "phoneNumber": null,
  "birthday": null,
  "optInComment": null,
  "optInSent": true,
  "createdAt": "2021-01-22 10:28:00",
  "updatedAt": null
}

Content‑Type Header​

Stelle sicher, dass deine Requests die korrekten Header enthalten:

Content-Type: application/json
Accept: application/json

Dies garantiert, dass die API deine Daten korrekt interpretiert und die richtigen Response‑Header zurücksendet.