Versions Compared

Version Old Version 11 New Version Current
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title5.0.0

The Email Notification REST API provides a mechanism for sending email-based notifications via ServiceBroker, so that systems integrated with ServiceBroker do not need to integrate with yet another system for the sending of email-based notifications.  


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Send an email-based notification

POST /up/v5/bns/email

HTTP Headers

This API uses custom HTTP Headers:

HeaderTypeRequired?Description
AuthorizationstringYesThe Authorization header for this API is the same as for the REST Integration Standard HTTP Headers.
Content-TypestringYes

The Content-Type HTTP Header may be set to either:

  • text/plain; or
  • text/html

The value of this header will determine if a plain text or HTML email notification will be sent.

TostringYesThe email address that the email-based notification should be sent to.
FromstringYesThe email address that the email-based notification should be sent from.
SubjectstringYesThe subject of the email-based notification.

API Specific Parameters

This API does not have any API specific parameters. 


API Specifics


Panel
borderColor#D3D3D3

Send an email-based notification

This REST API will send an email notification, based on the details provided in the HTTP Headers and Body.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /up/v5/bns/email

HTTP Request Body

This REST API requires a body, containing either the text-based or HTML-based content for the body of the email notification.

HTTP Response

Success

On success, an HTTP response code of 200 will be returned.

Error

Include Page
_Default Response
_Default Response