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

CAPTAIN — persist the per-team free-agent invitation message. body { invitationMessage }. Captain-gated on the route team. Wraps the page-pure FreeAgentApi.SaveInvitationMessage (FreeAgentApi.cs:370 — re-gates team.IsTeamAdmin at :383; team.UpdateFreeAgentInvitationMessage). Returns BooleanOutVO(true).

Request Information

Parameters

NameDescriptionAdditional information
id
team id (captain's team)

Define this parameter in the request URI.

inVO
{ invitationMessage }

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "invitationMessage": "sample string 1"
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

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

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

BooleanOutVO — true when the message is saved

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.