Adding a notification address to the organisation

Note

For this request, you need administration rights for the organisation or SOC rights.

Note

The address must not already be registered for the organisation; otherwise the request returns a 422 error.

Sends a POST request to the endpoint /organisations/{organisation}/notification-emails.

Description

The Add-Notification-Email request allows you to register an additional notification contact for an organisation that is not a user of the application, for example a shared mailbox or an external partner. A verification email is sent to the address so the contact can confirm the enrolment.

Requirements

Values of the request: Organisation ID {organisation}

Objects: none

Request

To add a notification contact, add the Organisation ID {organisation} to the path of the request and define the target address in the body:

Attributes	Description	Values
email	The notification address to add.	string

As a result, you get the created object NotificationEmail. The contact remains unverified until the recipient confirms the verification email.

The object provides the following information:

Attributes	Description	Values
id	The ID of the notification address.	string
email	The notification address.	string
verified	Indicates whether the address has been verified.	true, false
verified_at	The date and time when the address was verified in ISO 8601 format. While the address is unverified, the value is null.	string($date-time)

Example

Example request body:

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

Responses

The following responses are available:

STATUS CODE	DESCRIPTION
201	The request has succeeded and the notification address has been created.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.
422	The request was unsuccessful because the submitted data could not be processed.