Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.nudgen.net/llms.txt

Use this file to discover all available pages before exploring further.

​
Übersicht

Die Nudgen Entwickler-API bietet eine saubere, ressourcenorientierte REST-Schnittstelle zur Verwaltung Ihrer Marketing-Infrastruktur. Alle Anfragen nutzen Standard-HTTP-Methoden und liefern vorhersehbare JSON-Antworten.

PAT Authentifizierung

Authentifizierung mit Personal Access Tokens über den Standard-Bearer-Header.

Sauberes REST

Vorhersehbare, ressourcenorientierte URLs mit Standard-HTTP-Methoden.

Rate Limited

Integriertes Rate-Limiting pro Team und Endpunkt zum Schutz Ihrer Workflows.

​
Authentifizierung

Alle API-Anfragen erfordern einen Personal Access Token (PAT), der über den Authorization-Header übermittelt wird. Sie können Token in Ihrem Nudgen-Dashboard unter Einstellungen → API-Schlüssel erstellen. 
curl -X GET https://app.nudgen.com/api/v1/user/me \
  -H "Authorization: Bearer <your-pat>"

​
Basis-URL

Die Basis-URL für alle API-Anfragen lautet: https://app.nudgen.com

​
Endpunkte

​
Authentifizierung & Identität

  • GET /api/v1/user/me: Den aktuell authentifizierten Benutzer abrufen.
  • GET /api/v1/teams: Alle Teams des aktuellen Benutzers auflisten.
  • POST /api/v1/teams/switch: Den aktiven Team-Kontext wechseln.

​
Kontakte

  • GET /api/v1/contacts: Kontakte mit Paginierung, Suche und Tag-Filtern auflisten.
  • POST /api/v1/contacts/add: Einen neuen Kontakt erstellen.
  • GET /api/v1/contacts/:id: Einen spezifischen Kontakt abrufen.
  • PATCH /api/v1/contacts/:id: Einen bestehenden Kontakt aktualisieren.
  • DELETE /api/v1/contacts/:id: Einen Kontakt löschen.

​
Kampagnen

  • GET /api/v1/campaigns: Kampagnen im aktuellen Team auflisten.
  • POST /api/v1/campaigns: Eine neue Kampagne erstellen.
  • GET /api/v1/campaigns/:id: Kampagnen-Details abrufen.
  • GET /api/v1/campaigns/:id/stats: Zustellstatistiken einer Kampagne abrufen.

​
Vorlagen

  • GET /api/v1/templates: E-Mail-Vorlagen auflisten.
  • POST /api/v1/templates: Eine neue E-Mail-Vorlage erstellen.

​
Einstellungen

  • GET /api/v1/settings/brand: Markenkonfiguration abrufen.
  • PATCH /api/v1/settings/brand: Markeneinstellungen aktualisieren.

​
OpenAPI-Spezifikation

Sie können unsere vollständige OpenAPI-Spezifikation hier herunterladen: openapi.json