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
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
customer_id | long | Ja | Die eindeutige ID des Kunden |
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
X-Api-Key | string | Ja | API-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
| Feld | Typ | Beschreibung |
|---|---|---|
success | boolean | Gibt an, ob die E-Mail erfolgreich versendet wurde |
errorMessage | string? | Fehlermeldung, falls ein Fehler aufgetreten ist (ansonsten null) |
Status-Codes
| Code | Beschreibung |
|---|---|
200 | OK - Anfrage wurde verarbeitet (prüfe success-Feld) |
400 | Bad Request - Kunde hat keine E-Mail-Adresse |
401 | Unauthorized - API-Schlüssel ist ungültig oder fehlt |
403 | Forbidden - Keine Zugriffsberechtigung auf den Kunden |
404 | Not Found - Kunde existiert nicht |
Funktionsweise
- Authentifizierung über API-Schlüssel
- Zugriffsprüfung auf den Kunden
- E-Mail-Validierung (muss hinterlegt sein)
- Generierung eines privaten Links (gültig für 30 Tage)
- E-Mail-Versand an den Kunden