REST API for Oracle Commerce Cloud December 2017

updateEmailTemplates

put

/ccadmin/v1/email/types/{emailTypeId}/templates

Update Email Templates. Updates templates for an email type from previously uploaded zip file.

Request

Supported Media Types

application/json

Path Parameters

emailTypeId: Type: string

Required: true

ID of email type.

Body Parameter

Root Schema : updateEmailTemplates_request

Example


{
    "filename":"notifications/uploads/abandoned_order_v1.zip"
}

Properties

filename: Type: string

Required: true

Path to previously uploaded zip file containing email templates to apply for the specified email type.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateEmailTemplates_response

Properties

displayName: Type: string

The display name for the email type
errors: Type: array errors

Additional Properties Allowed:

Errors reported for the update.
success: Type: boolean

true - if update was successful, false - if update was unsuccessful
warnings: Type: array warnings

Additional Properties Allowed:

Warnings reported for the update.

Nested Schema : errors

Type: array

Errors reported for the update.

Items

Type: string

Nested Schema : warnings

Type: array

Warnings reported for the update.

Items

Type: string

Example application/json


{
    "success":true,
    "displayName":"Abandoned Cart",
    "warnings":[
        "Locale 'sh' referenced in 'locales/sh/Strings.xlf' is not a supported locale. This folder and its contents will not be uploaded."
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://slc01ghw.us.oracle.com:9080/ccadminui/v1/email/types/abandoned_order_v1/templates"
        }
    ],
    "errors":[
    ]
}

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:

{"filename": "notifications/uploads/abandoned_order_v1.zip"}

Sample Response Payload returned by endpoint:

{
  "success": true,
  "displayName": "Abandoned Cart",
  "warnings": ["Locale 'sh' referenced in 'locales/sh/Strings.xlf' is not a supported locale. This folder and its contents will not be uploaded."],
  "links": [{
    "rel": "self",
    "href": "http://slc01ghw.us.oracle.com:9080/ccadminui/v1/email/types/abandoned_order_v1/templates"
  }],
  "errors": []
}