REST API for Oracle Commerce Cloud December 2017

sendEmailNotification

post

/ccadmin/v1/emailNotifications

Send Email Notification. Creates a new outbound email notification.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : sendEmailNotification_request

Example


{
    "postContent":"SureShot Camera XYZ",
    "postProductImageUrl":"https://shope.example.com/products/productImage.png",
    "wishListDisplayName":"Jane''s Wish List",
    "postCreatorProfileImageURL":"https://shope.example.com/profiles/fredImage.png",
    "wishListId":"abcdefg",
    "wishListOwnerFirstName":"Jane",
    "messageDetails":{
        "notificationType":"wishlist_new_post_v1",
        "locale":"en-US",
        "toEmail":"member@example.com"
    },
    "wishListOwnerProfileImageURL":"https://shope.example.com/profiles/janeImage.png",
    "storeFrontHostName":"https://shope.example.com",
    "organization":{
        "name":"Jane''s Organization",
        "logoUrl":"https://shope.example.com/org/JanesOrgLogo.png"
    },
    "recipientFullName":"Member User",
    "recipientEmailAddress":"member@example.com",
    "postCreatorFirstName":"Fred",
    "productPrice":"$65.00",
    "wishListOwnerLastName":"Doe",
    "postCreatorLastName":"Shawpper"
}

Properties

(other object properties): Type: object (other object properties)

Required: true

Additional Properties Allowed:

(message notification type specific properties)
(other string properties): Type: string

Required: true

(message notification type specific properties)
messageDetails: Type: array messageDetails

Required: true

Additional Properties Allowed:

Email recipient / language info.

Nested Schema : (other object properties)

Type: object

(message notification type specific properties)

Nested Schema : messageDetails

Type: array

Email recipient / language info.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

locale: Type: string

Required: true

Locale code of the language to use for message.
notificationType: Type: string

Required: true

Type of notification to be sent.
toEmail: Type: string

Required: true

Email to which the notification will be sent.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : sendEmailNotification_response

Properties

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "postContent": "SureShot Camera XYZ",
  "postProductImageUrl": "https://shope.example.com/products/productImage.png",
  "wishListDisplayName": "Jane''s Wish List",
  "postCreatorProfileImageURL": "https://shope.example.com/profiles/fredImage.png",
  "wishListId": "abcdefg",
  "wishListOwnerFirstName": "Jane",
  "messageDetails": {
    "notificationType": "wishlist_new_post_v1",
    "locale": "en-US",
    "toEmail": "member@example.com"
  },
  "wishListOwnerProfileImageURL": "https://shope.example.com/profiles/janeImage.png",
  "storeFrontHostName": "https://shope.example.com",
  "organization": {
    "name": "Jane''s Organization",
    "logoUrl": "https://shope.example.com/org/JanesOrgLogo.png"
  },
  "recipientFullName": "Member User",
  "recipientEmailAddress": "member@example.com",
  "postCreatorFirstName": "Fred",
  "productPrice": "$65.00",
  "wishListOwnerLastName": "Doe",
  "postCreatorLastName": "Shawpper"
}