POST v3/me/teams/{id}/captain/invite

CAPTAIN — invite members to the team by email. body { emails, message? }. Captain-gated on the route team. Wraps the page-pure TeamApi.SendInvitations (TeamApi.cs:44 — re-gates CommonHelper.IsTeamAdmin at :58): for each email it loads the member, checks Team.CanMemberBeInvited, and inserts a PENDING TeamMembers row (Approved=false, JoinedType=InvitedByCaptain, Text=message). Returns the SendInvitationsOutVO buckets (invitedEmailList / already-invited / unable-to-join / unknown).

Request Information

Parameters

Name	Description	Additional information
id	team id (captain's team)	Define this parameter in the request URI.
inVO	{ emails: string[], message?: string }	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "emails": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "message": "sample string 1"
}

application/xml, text/xml

Sample:

<CaptainInviteInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Web.API.Models.Input">
  <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 1</message>
</CaptainInviteInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="emails[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="emails[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="emails[2]"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="message"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

SendInvitationsOutVO — the per-email result buckets

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.