tencent cloud

Simple Email Service

News and Announcements
Release Notes
Announcement on a Newly Added Independent IP Value-Added Service
Product Introduction
Overview
Features
Strengths
Use Cases
Specifications
Purchase Guide
Pricing
Getting Started
Email Configuration
Email Sending
Reputation Level
Console Guide
Configuration
Email Sending
Statistics
Delivery Response
API Documentation
History
Introduction
API Category
Making API Requests
Domain Verification APIs
Mail APIs
Template APIs
Statistics APIs
Sender Address APIs
Blocklist APIs
Sending Status Query APIs
Batch Task APIs
Custom Blocklist APIs
Data Types
Error Codes
SMTP Documentation
SMTP Email Sending Guide
SMTP Service Address
Sample Call for Java
Sample Call for Go
Sample Call for PHP
Sample Call for Python
Sample Call for C#
Sending Email with Attachment
Error Code
Webhook Documentation
Email Event Notification
Email Sending Restrictions
Attachment Types
FAQs
Getting Started
Billing
Sending Limits
Sending Feature
Domain
Template
Identity Verification and Configuration
Independent IP Related Questions
Delivery
API Use
Callback
Spam Folder
Security
Domain Acceleration Configuration
Important Notes
Others
Contact Us

CreateCustomBlacklist

PDF
Focus Mode
Font Size
Last updated: 2026-02-25 17:00:14

1. API Description

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

Add a custom blocklist.

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: CreateCustomBlacklist.
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. This API only supports: ap-singapore.
Emails.N Yes Array of String Add to blocklist email address.
ExpireDate No Date Expiration date.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of recipients.
ValidCount Integer Actual uploaded quantity.
TooLongCount Integer Data too long quantity.
RepeatCount Integer Repetition count.
InvalidCount Integer Incorrect format count.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Adding an Email Address to the Blocklist

Input Example

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

{
    "ExpireDate": "2024-06-19",
    "Emails": [
        "b@gmail.com",
        "a@gmail.com"
    ]
}

Output Example

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

Example2 Successful Example

Successful Example

Input Example

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

{
    "Emails": [
        "resrse@sdasd.com",
        "resrse@sdasd.com",
        "asdasdasdasd"
    ]
}

Output Example

{
    "Response": {
        "InvalidCount": 1,
        "RepeatCount": 1,
        "RequestId": "1e6f3195-f832-42a4-87ca-265a80435bc0",
        "TooLongCount": 0,
        "TotalCount": 3,
        "ValidCount": 1
    }
}

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
InvalidParameterValue.WrongDate Incorrect search date. Make sure the date and its format are valid.
LimitExceeded.ReceiverDetailRequestLimit The number of recipient addresses requested exceeds the limit.
MissingParameter.EmailsNecessary The recipient email address is required.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback