tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateAndSendClientInvitationMail

Last updated: 2024-12-19 14:16:41

1. API Description

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

This API is used to apply for the allowlist. If needed, please contact your business representative.Directions:
1.This API is used to create an invitation link, which you can send to a specified email address.
2.Customer need to click the invitation link in the email, fill in and submit the required information.
3.You can review the customer's application in customer management after submission.

Note:This API is used to manually send the invitation link to the customer if the specified email does not receive it.

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: CreateAndSendClientInvitationMail.
Version Yes String Common Params. The value used for this API: 2022-09-28.
Region No String Common Params. This parameter is not required.
Email Yes String Email address that receives the customer invitation link.

3. Output Parameters

Parameter Name Type Description
InvitationLink String Specifies the invitation link for the customer.
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

Input Example

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

{
    "Email": "abc@gmail.com"
}

Output Example

{
    "Response": {
        "InvitationLink": "https://www.tencentcloud.com/reseller-customer/invitation?RegisterToken=28c******2f",
        "RequestId": "91158930-****-496f-****-8f32f5edabcc"
    }
}

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.SendMailLimit180 The interval between sending invitation links is less than three minutes. Please try again later.
OperationDenied.ServiceBusy System busy. Please try again later.
RequestLimitExceeded Too many requests.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy