REST Notification Email
- Andrew Hill (Deactivated)
- Jason Andrew
- Mickey Bushman
Resource URL Summary
Send an email-based notification
POST /up/v5/bns/email
HTTP Headers
This API uses custom HTTP Headers:
| Header | Type | Required? | Description |
|---|---|---|---|
Authorization | string | Yes | The Authorization header for this API is the same as for the REST Integration Standard HTTP Headers. |
Content-Type | string | Yes | The
The value of this header will determine if a plain text or HTML email notification will be sent. |
To | string | Yes | The email address that the email-based notification should be sent to. |
From | string | Yes | The email address that the email-based notification should be sent from. |
Subject | string | Yes | The subject of the email-based notification. |
API Specific Parameters
This API does not have any API specific parameters.
API Specifics
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
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
Otherwise, on error, the API will:
- Return an HTTP response code of 400, if the request was invalid;
- Return an HTTP response code of 401, if the request was not authorized; or
- Return an HTTP response code of 500, if something else went wrong.
Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.