POST v3/me/teams/{id}/captain/invite-free-agent

CAPTAIN — invite one free agent from the pool. body { freeAgentId, invitationMessage? }. Captain-gated on the route team. Wraps the page-pure FreeAgentApi.SendInvitation (FreeAgentApi.cs:392 — re-gates team.IsTeamAdmin at :410; rejects if the free agent is already on the team): inserts a PENDING TeamMembers row (Approved=false, JoinedType=InvitedByCaptain, Text=invitationMessage). Returns BooleanOutVO(true) on success.

Request Information

Parameters

NameDescriptionAdditional information
id 
team id (captain's team)

Define this parameter in the request URI.
inVO 
{ freeAgentId, invitationMessage? }

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "freeAgentId": "sample string 1",
  "invitationMessage": "sample string 2"
}

application/xml, text/xml

Sample: 
<CaptainInviteFreeAgentInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Web.API.Models.Input">
  <freeAgentId>sample string 1</freeAgentId>
  <invitationMessage>sample string 2</invitationMessage>
</CaptainInviteFreeAgentInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="freeAgentId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="invitationMessage"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

BooleanOutVO — true when the pending invite row is inserted

Response body formats

application/json, text/json

Sample: 
{
  "returnValue": true,
  "code": 0,
  "message": "sample string 2"
}

application/xml, text/xml

Sample: 
<BooleanOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Common">
  <code>None</code>
  <message>sample string 2</message>
  <returnValue>true</returnValue>
</BooleanOutVO>

multipart/form-data

Sample:

Sample not available.