setEmailServiceData

post

/ccadmin/v1/email

Set Email Service Data. Update the email service data.

Request

Supported Media Types
Body ()
Root Schema : setEmailServiceData_request
Type: object
Show Source
Example:
{
    "emailServiceProperties":{
        "emailSMTPPort":"25",
        "emailSMTPHost":"127.0.0.1",
        "emailServiceType":"BASIC",
        "emailSMTPAuthMethod":"TLS",
        "emailSMTPPassword":"",
        "emailSMTPUsername":""
    },
    "emailNotificationTypes":[
        {
            "verificationStatus":0,
            "displayName":"Forgot Password Email",
            "recommendationsRestriction":null,
            "fromName":"Forgot Password",
            "includeRecommendations":false,
            "id":"forgot_password_v1",
            "numberOfRecommendations":3,
            "recommendationsStrategy":null,
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com"
        },
        {
            "verificationStatus":0,
            "displayName":"Abandon Order",
            "recommendationsRestriction":"unrestricted",
            "fromName":"Abandon Order xx",
            "includeRecommendations":true,
            "id":"abandon_order_v1",
            "numberOfRecommendations":3,
            "recommendationsStrategy":"blended",
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com"
        },
        {
            "verificationStatus":0,
            "displayName":"New Account Email",
            "recommendationsRestriction":null,
            "fromName":"New Account xx",
            "includeRecommendations":true,
            "id":"account_registration_v1",
            "numberOfRecommendations":3,
            "recommendationsStrategy":"bestSellers",
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com"
        }
    ]
}
Nested Schema : emailNotificationTypes
Type: array
Email Notification Types
Show Source
Nested Schema : emailServiceProperties
Type: object
Email Service Properties
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : setEmailServiceData_response
Type: object
Show Source
Nested Schema : emailNotificationTypes
Type: array
Email notification types
Show Source
Nested Schema : emailServiceProperties
Type: object
Email service properties
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : recommendationsPermittedStrategies
Type: array
Array of recommendation strategy keys permitted for this notification type
Show Source
Example Response (application/json)
{
    "emailServiceProperties":{
        "emailSMTPPort":"25",
        "emailSMTPHost":"127.0.0.1",
        "emailServiceType":"BASIC",
        "emailSMTPAuthMethod":"TLS",
        "emailSMTPUsername":""
    },
    "emailNotificationTypes":{
        "abandoned_order_v1":{
            "recommendationsSupported":true,
            "verificationStatus":0,
            "displayName":"Abandon Order",
            "description":null,
            "recommendationsStrategy":"blended",
            "version":1,
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com",
            "recommendationsAllowAnyStrategy":true,
            "recommendationsRestriction":"unrestricted",
            "fromName":"Abandon Order xx",
            "recommendationsAllowRestrictions":true,
            "includeRecommendations":true,
            "id":"abandoned_order_v1",
            "numberOfRecommendations":3,
            "recommendationsPermittedStrategies":[
            ]
        },
        "forgot_password_v1":{
            "recommendationsSupported":false,
            "verificationStatus":0,
            "displayName":"Forgotten Password",
            "description":null,
            "recommendationsStrategy":null,
            "version":1,
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com",
            "recommendationsAllowAnyStrategy":true,
            "recommendationsRestriction":null,
            "fromName":"Forgot Password",
            "recommendationsAllowRestrictions":true,
            "includeRecommendations":false,
            "id":"forgot_password_v1",
            "numberOfRecommendations":12,
            "recommendationsPermittedStrategies":[
            ]
        },
        "account_registration_v1":{
            "recommendationsSupported":true,
            "verificationStatus":0,
            "displayName":"New Account",
            "description":null,
            "recommendationsStrategy":"topSellers",
            "version":1,
            "enabled":true,
            "fromEmail":"info@slc04lxz.us.oracle.com",
            "recommendationsAllowAnyStrategy":false,
            "recommendationsRestriction":null,
            "fromName":"New Account xx",
            "recommendationsAllowRestrictions":false,
            "includeRecommendations":true,
            "id":"account_registration_v1",
            "numberOfRecommendations":12,
            "recommendationsPermittedStrategies":[
                "topSellers"
            ]
        }
    }
}

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top