CreateAndSendClientInvitationMail

Last updated: 2025-10-30 21:45:27

CreateAndSendClientInvitationMail

Last updated: 2025-10-30 21:45:27

1. API Description

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

This API is used to perform operations. Application for allowlist is required before usage. If needed, contact your business representative to request allowlisting. The specific usage process is as follows;.
This API is used to create an invitation link. You can send the invitation link to your designated email address.

Customers need to click the invitation link in the mailbox, fill in and submit relevant information.
After customer submission, you can view the application of this sub-customer on the customer management page and review it.

This API is used to handle cases where if the designated mailbox does not receive the invitation link, you can send the invitation link returned by the API to the customer manually.
Invocation roles: resellers, distributors, second-level reseller.

A maximum of 1 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.
InvitationRole	No	String	Invite a role. Note: if no value is passed, it defaults to the sub - customer. Client: customer. SubAgent: second-level reseller.
MaterialUrl	No	String	Specifies the application material. Note: this field takes effect only in the scenario of inviting a second-level reseller.

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

Example1 Creating an Invitation Link for the Customer

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

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud