SendOrganizationInvitation

Last updated: 2020-08-18 11:30:13

1. API Description

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

This API is used to send an invitation to join an organization.

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 parameter. The value used for this API: SendOrganizationInvitation.
Version Yes String Common parameter. The value used for this API: 2018-12-25.
Region No String Common parameter. This parameter is not required for this API.
InviteUin Yes Integer UIN of the invitee
Name Yes String Name
Remark Yes String Notes

3. Output Parameters

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

4. Example

Example1 Sending an invitation to join an organization

Input Example

https://organization.tencentcloudapi.com/?Action=SendOrganizationInvitation
&InviteUin=123
&Name="test"
&Remark="test"
&<Common Request Parameters>

Output Example

{
  "Response": {
    "RequestId": "b46d2afe-6893-4529-bc96-2c82d9214957"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.MemberNameUsed The name is already in use.
FailedOperation.ReSentInvitation The invitation has already been sent before.
FailedOperation.UserInOrganization The user has already joined the organization.
FailedOperation.UserNotRegister The account that sent the invitation is not a primary account.
LimitExceeded.Members The number of organization members has reached the maximum.
ResourceNotFound.OrganizationNotExist The organization does not exist.
ResourceNotFound.UserNotExist The user does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help