Benachrichtigungsadresse zu einer Organisation hinzufügen¶

Note

Die Adresse darf für die Organisation noch nicht registriert sein; andernfalls gibt die Anfrage einen 422-Fehler zurück.

Senden einer POST-Anfrage an den Endpunkt /organisations/{organisation}/notification-emails.

Beschreibung¶

Mit der Add-Notification-Email-Anfrage registrieren Sie als Organisationsadministration eine zusätzliche Benachrichtigungsadresse, die kein Anwendungskonto besitzt, zum Beispiel ein Gruppenpostfach oder eine externe Partneradresse. An die Adresse wird eine Bestätigungs-E-Mail gesendet, mit der sie die Aufnahme bestätigt.

Voraussetzungen¶

Werte der Anfrage: Organisation-ID {organisation}

Objekte: keine

Anfrage¶

Um eine Benachrichtigungsadresse hinzuzufügen, fügen Sie die Organisation-ID {organisation} in den Pfad der Anfrage ein und definieren die Adresse im Body:

Attribut	Beschreibung	Werte
`email`	Die Benachrichtigungsadresse, die hinzugefügt wird.	`string`

Als Ergebnis erhalten Sie das erstellte Objekt NotificationEmail, das so lange nicht verifiziert ist, bis die Adresse die Aufnahme bestätigt.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`id`	Die ID der Benachrichtigungsadresse.	`string`
`email`	Die Benachrichtigungsadresse.	`string`
`verified`	Definiert, ob die Adresse verifiziert ist.	`true` `false`
`verified_at`	Der Zeitpunkt der Verifizierung im ISO-8601-Format oder `null`.	`string($date-time)`

Beispiel¶

Beispiel-Request-Body:

{
  "email": "alerts@example.com"
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
201	Die Anfrage war erfolgreich und das Element wurde erstellt.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.
422	Die Anfrage war nicht erfolgreich, da die übermittelten Daten nicht verarbeitet werden konnten.