Adding a notification address to an organisation¶

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 an organisation admin to register an additional notification contact that is not an application user, for example a shared mailbox or an external partner. A verification email is sent to the address so that it 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, the user gets the created NotificationEmail object, which is unverified until the recipient confirms it.

The object provides the following information:

Attributes	Description	Values
`id`	The ID of the notification email.	`string`
`email`	The notification address.	`string`
`verified`	Whether the address has been verified.	`true` `false`
`verified_at`	The time at which the address was verified in ISO 8601 format, or `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 element was 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.