Benachrichtigungsadresse zur Organisation hinzufügen

Note

Für diese Anfrage benötigen Sie Administrationsrechte für die Organisation oder SOC-Rechte.

Note

Die Adresse darf noch nicht für die Organisation 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 für eine Organisation einen zusätzlichen Benachrichtigungskontakt, der kein Nutzender der Anwendung ist, zum Beispiel ein gemeinsames Postfach oder einen externen Partner. An die Adresse wird eine Bestätigungs-E-Mail gesendet, mit der der Kontakt die Anmeldung bestätigt.

Voraussetzungen

Werte der Anfrage: Organisation-ID {organisation}

Objekte: keine

Anfrage

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

Attribut	Beschreibung	Werte
email	Die hinzuzufügende Benachrichtigungsadresse.	string

Als Ergebnis erhalten Sie das erzeugte Objekt NotificationEmail. Der Kontakt bleibt unbestätigt, bis der Empfänger die Bestätigungs-E-Mail bestätigt hat.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
id	Die ID der Benachrichtigungsadresse.	string
email	Die Benachrichtigungsadresse.	string
verified	Zeigt an, ob die Adresse bestätigt wurde.	true, false
verified_at	Datum und Uhrzeit der Bestätigung der Adresse im ISO-8601-Format. Solange die Adresse nicht bestätigt ist, ist der Wert 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 die Benachrichtigungsadresse wurde angelegt.
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.