Zum Hauptinhalt springen

Fragebogen an Kunden versenden

Dieser Endpoint generiert einen privaten Fragebogen-Link für einen Kunden und versendet diesen per E-Mail. Der Link zum Ausfüllen des Fragebogens ist für 30 Tage gültig.

Endpoint-Details

HTTP-Methode: POST

URL: /external/v1/customers/{customer_id}/send_questionnaire

Authentifizierung: API-Schlüssel (erforderlich)

Parameter

URL-Parameter

ParameterTypErforderlichBeschreibung
customer_idlongJaDie eindeutige ID des Kunden
HeaderTypErforderlichBeschreibung
X-Api-KeystringJaAPI-Schlüssel für die Authentifizierung

Response

Erfolgreiche Response (200 OK)

{
"success": true,
"errorMessage": null
}

Fehlerhafte Response (400 Bad Request)

{
"success": false,
"errorMessage": "Customer with Id '12345' does not have an email address"
}

Response-Felder

FeldTypBeschreibung
successbooleanGibt an, ob die E-Mail erfolgreich versendet wurde
errorMessagestring?Fehlermeldung, falls ein Fehler aufgetreten ist (ansonsten null)

Status-Codes

CodeBeschreibung
200OK - Anfrage wurde verarbeitet (prüfe success-Feld)
400Bad Request - Kunde hat keine E-Mail-Adresse
401Unauthorized - API-Schlüssel ist ungültig oder fehlt
403Forbidden - Keine Zugriffsberechtigung auf den Kunden
404Not Found - Kunde existiert nicht

Funktionsweise

  1. Authentifizierung über API-Schlüssel
  2. Zugriffsprüfung auf den Kunden
  3. E-Mail-Validierung (muss hinterlegt sein)
  4. Generierung eines privaten Links (gültig für 30 Tage)
  5. E-Mail-Versand an den Kunden