Jump to

• Request
• Response

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: string
  ID of email type.

Body ()

Root Schema : updateEmailTemplates_request

Type: object

Show Source

• filename: string
  Path to previously uploaded zip file containing email templates to apply for the specified email type.

{
    "properties":{
        "filename":{
            "description":"Path to previously uploaded zip file containing email templates to apply for the specified email type.",
            "type":"string"
        }
    },
    "required":[
        "filename"
    ],
    "example":{
        "filename":"notifications/uploads/abandoned_order_v1.zip"
    }
}

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateEmailTemplates_response

Type: object

Show Source

• displayName(optional): string
  The display name for the email type
• errors(optional): array errors
  Errors reported for the update.
• success(optional): boolean
  true - if update was successful, false - if update was unsuccessful
• warnings(optional): array warnings
  Warnings reported for the update.

{
    "properties":{
        "success":{
            "description":"true - if update was successful, false - if update was unsuccessful",
            "type":"boolean"
        },
        "displayName":{
            "description":"The display name for the email type",
            "type":"string"
        },
        "warnings":{
            "description":"Warnings reported for the update.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "errors":{
            "description":"Errors reported for the update.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

Errors reported for the update.

Show Source

• Array of: string

{
    "description":"Errors reported for the update.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

Warnings reported for the update.

Show Source

• Array of: string

{
    "description":"Warnings reported for the update.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (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://admin.example.com/ccadminui/v1/email/types/abandoned_order_v1/templates"
        }
    ],
    "errors":[
    ]
}

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