Jump to

• Request
• Response

sendEmailNotification

post

/ccadmin/v1/emailNotifications

Send Email Notification. Creates a new outbound email notification.

Request

Supported Media Types

• application/json

Body ()

Root Schema : sendEmailNotification_request

Type: object

Show Source

• (other object properties): object (other object properties)
  (message notification type specific properties)
• (other string properties): string
  (message notification type specific properties)
• messageDetails: array messageDetails
  Email recipient / language info.

{
    "properties":{
        "(other string properties)":{
            "description":"(message notification type specific properties)",
            "type":"string"
        },
        "messageDetails":{
            "description":"Email recipient / language info.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "notificationType":{
                        "description":"Type of notification to be sent.",
                        "type":"string"
                    },
                    "locale":{
                        "description":"Locale code of the language to use for message.",
                        "type":"string"
                    },
                    "toEmail":{
                        "description":"Email to which the notification will be sent.",
                        "type":"string"
                    }
                },
                "required":[
                    "notificationType",
                    "locale",
                    "toEmail"
                ]
            }
        },
        "(other object properties)":{
            "description":"(message notification type specific properties)",
            "type":"object"
        }
    },
    "required":[
        "(other string properties)",
        "messageDetails",
        "(other object properties)"
    ],
    "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":"[e-mail]"
        },
        "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":"[e-mail]",
        "postCreatorFirstName":"Fred",
        "productPrice":"$65.00",
        "wishListOwnerLastName":"Doe",
        "postCreatorLastName":"Shawpper"
    }
}

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":"[e-mail]"
    },
    "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":"[e-mail]",
    "postCreatorFirstName":"Fred",
    "productPrice":"$65.00",
    "wishListOwnerLastName":"Doe",
    "postCreatorLastName":"Shawpper"
}

Nested Schema : (other object properties)

Type: object

(message notification type specific properties)

Nested Schema : messageDetails

Type: array

Email recipient / language info.

Show Source

• Array of: object items

{
    "description":"Email recipient / language info.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "notificationType":{
                "description":"Type of notification to be sent.",
                "type":"string"
            },
            "locale":{
                "description":"Locale code of the language to use for message.",
                "type":"string"
            },
            "toEmail":{
                "description":"Email to which the notification will be sent.",
                "type":"string"
            }
        },
        "required":[
            "notificationType",
            "locale",
            "toEmail"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• locale: string
  Locale code of the language to use for message.
• notificationType: string
  Type of notification to be sent.
• toEmail: string
  Email to which the notification will be sent.

{
    "type":"object",
    "properties":{
        "notificationType":{
            "description":"Type of notification to be sent.",
            "type":"string"
        },
        "locale":{
            "description":"Locale code of the language to use for message.",
            "type":"string"
        },
        "toEmail":{
            "description":"Email to which the notification will be sent.",
            "type":"string"
        }
    },
    "required":[
        "notificationType",
        "locale",
        "toEmail"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : sendEmailNotification_response

Show Source

{
    "properties":{
    }
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top