POST v3/me/teams/{id}/invite
send invitation to members to join his team by team captain or co-captian v2 version, you can send email_type and url for the email of recit
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| id | the id of the team |
Define this parameter in the request URI. |
| vo | an object include the information of invitations,
message - message to invite members;
emails - a list of email adress of members who are invited.
email_type - the email type you want to send
url - the URL that the links in the email will open |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"teamId": "sample string 1",
"message": "sample string 2",
"emails": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"curUserId": "sample string 3",
"isSSO": true,
"requestHost": "sample string 5",
"applicationPath": "sample string 6",
"secureApplicationPath": "sample string 7",
"absoluteApplicationPath": "sample string 8",
"isHttps": true,
"isMobileDevice": true,
"isElectron": true,
"isFullEmbed": true,
"clientType": 0,
"clientVersion": "sample string 13",
"clientOS": "sample string 14",
"clientBuild": "sample string 15",
"premiumAppId": "sample string 16",
"clientWidth": 17,
"clientHeight": 18,
"timezone": 19
}
application/xml, text/xml
Sample:
<SendInvitationsInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">
<ClientHeight>18</ClientHeight>
<ClientType>Site</ClientType>
<ClientWidth>17</ClientWidth>
<absoluteApplicationPath>sample string 8</absoluteApplicationPath>
<applicationPath>sample string 6</applicationPath>
<cachedKey>sample string 1</cachedKey>
<clientBuild>sample string 15</clientBuild>
<clientOS>sample string 14</clientOS>
<clientVersion>sample string 13</clientVersion>
<curUserId>sample string 3</curUserId>
<isElectron>true</isElectron>
<isFullEmbed>true</isFullEmbed>
<isHttps>true</isHttps>
<isMobileDevice>true</isMobileDevice>
<isSSO>true</isSSO>
<premiumAppId>sample string 16</premiumAppId>
<requestHost>sample string 5</requestHost>
<secureApplicationPath>sample string 7</secureApplicationPath>
<timezone>19</timezone>
<emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</emails>
<message>sample string 2</message>
<teamId>sample string 1</teamId>
</SendInvitationsInVO>
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="cachedKey" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
return all emails that the invitation were sent to
Response body formats
application/json, text/json
Sample:
{
"joinedMemberList": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"unableJoinedDueToClosedMemberList": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"alreadyInvitedMemberList": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"unableJoinedUnknowMemberList": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"unableJoinedUnknowMemberErrorMessageList": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"invitedEmailList": [
"sample string 1",
"sample string 2",
"sample string 3"
]
}
application/xml, text/xml
Sample:
<SendInvitationsOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Division">
<alreadyInvitedMemberList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</alreadyInvitedMemberList>
<invitedEmailList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</invitedEmailList>
<joinedMemberList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</joinedMemberList>
<unableJoinedDueToClosedMemberList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</unableJoinedDueToClosedMemberList>
<unableJoinedUnknowMemberErrorMessageList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</unableJoinedUnknowMemberErrorMessageList>
<unableJoinedUnknowMemberList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</unableJoinedUnknowMemberList>
</SendInvitationsOutVO>
multipart/form-data
Sample:
Sample not available.