tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateEmailIdentity

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

1. API Description

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

This API is used to create a sender domain. Before you can send an email using Tencent Cloud SES, you must create a sender domain as your identity. It can be the domain of your website or mobile app. You must verify the domain to prove that you own it and authorize Tencent Cloud SES to use it 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: CreateEmailIdentity.
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.
EmailIdentity Yes String Your sender domain. You are advised to use a third-level domain, for example, mail.qcloud.com.

3. Output Parameters

Parameter Name Type Description
IdentityType String Verification type. The value is fixed to DOMAIN.
VerifiedForSendingStatus Boolean Verification passed or not.
Attributes Array of DNSAttributes DNS information that needs to be configured.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a sender domain

Input Example

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

{
    "EmailIdentity": "mail.qcloud.com"
}

Output Example

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "IdentityType": "DOMAIN",
        "VerifiedForSendingStatus": false,
        "Attributes": [
            {
                "Type": "TXT",
                "SendDomain": "mail.qcloud.com",
                "ExpectedValue": "v=spf1 include:qcloudmail.com ~all",
                "CurrentValue": "",
                "Status": false
            },
            {
                "Type": "TXT",
                "SendDomain": "mail._domainkey.mail.qcloud.com",
                "ExpectedValue": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDeMVIzrCa3T14JsNY0IRv5/2V1/v2itlviLQBwXsa7shBD6TrBkswsFUToPyMRWC9tbR/5ey0nRBH0ZVxp+lsmTxid2Y2z+FApQ6ra2VsXfbJP3HE6wAO0YTVEJt1TmeczhEd2Jiz/fcabIISgXEdSpTYJhb0ct0VJRxcg4c8c7wIDAQAB",
                "CurrentValue": "",
                "Status": false
            }
        ]
    }
}

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
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.CreatedByOther This sender domain has been created by another Tencent Cloud account.
InvalidParameterValue.InvalidEmailIdentity Invalid domain value.
InvalidParameterValue.RepeatCreation This sender domain already exists. Do not create it again.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.ExceedDomainLimit The number of sender domains exceeds the upper limit.
RequestLimitExceeded The number of requests exceeds the frequency limit.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy