Download email templates
/ccadmin/v1/email/types/{emailTypeId}/templates
Downloads the Freemarker templates for the subject and body of the email type for a specific site, along with associated locale-specific resource files, so that these can be viewed and customized.
Email templates are site-specific, so the correct site context must be specified via the X-CCSite request header or occsite query parameter. If the site context is omitted, the templates downloaded will be for the default site.
The email type to be downloaded is identified by the {emailTypeId} path parameter. The emailTypeId parameter must correspond to the ID of an existing email type.
The email templates and locale resources are downloaded as a zipped file in the endpoint response.
Note:If the request fails, a JSON object is returned instead of an application/zip file.
Request
- application/json
-
emailTypeId: string
ID of email type.
Response
- */*
200 Response
object
-
items(optional):
object items
Response content type is application/x-zip-compressed, with response body containing the compressed zip file containing templates for the email type.
object
404 Response
object
-
errorCode(optional):
string
00000000
-
message(optional):
string
Email type {emailType} does not exist
-
status(optional):
string
404
Default Response
Error Code | Description | Possible Fix |
---|---|---|
950049 | An unexpected error occurred building the zip file. | See the returned error messages for further information. |
The error response:
object
-
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
array
object
-
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