tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateEmailTemplate

Last updated: 2023-06-12 16:22:41

1. API Description

Domain name for API request: ses.tencentcloudapi.com.

This API is used to create a TEXT or HTML email template. To create an HTML template, ensure that it does not include external CSS files. You can use {{variable name}} to specify a variable in the template.
Note: Only an approved template can be used to send emails.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateEmailTemplate.
Version Yes String Common Params. The value used for this API: 2020-10-02.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TemplateName Yes String Template name.
TemplateContent Yes TemplateContent Template content.

3. Output Parameters

Parameter Name Type Description
TemplateID Integer Template ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an HTML email template

Input Example

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEmailTemplate
<Common request parameters>

{
    "TemplateContent": {
        "Html": "PGh0bWw+dGhpcyBpcyBhIGV4YW1wbGUge3tjb2RlfX08L2h0bWw+"
    },
    "TemplateName": "TestName"
}

Output Example

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "TemplateID": 123
    }
}

Example2 Creating a TEXT email template

Input Example

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEmailTemplate
<Common request parameters>

{
    "TemplateContent": {
        "Text": "dGhpcyBpcyBhIGV4YW1wbGUge3tjb2RlfX0="
    },
    "TemplateName": "TestName"
}

Output Example

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "TemplateID": 123
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.ExceedTemplateLimit The number of templates exceeds the upper limit.
FailedOperation.TemplateContentToolarge The template size is too large. Reduce the size.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.TemplateContentIsNULL The template resource is empty.
InvalidParameterValue.TemplateContentIsWrong Incorrect template content. Make sure the Base64 content is correct.
InvalidParameterValue.TemplateNameIllegal Invalid template name. Make sure the characters and length of the template name are valid.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
RequestLimitExceeded The number of requests exceeds the frequency limit.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy