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

CAPTAIN — read the persisted per-team free-agent invitation message (the default the compose box pre-fills with). Captain-gated on the route team. Wraps the page-pure FreeAgentApi.GetInvitationMessage (FreeAgentApi.cs:338 — re-gates team.IsTeamAdmin at :351; returns sanitized HTML). Returns { invitationMessage, errorMsg }.

Request Information

Parameters

Name	Description	Additional information
id	team id (captain's team)	Define this parameter in the request URI.

Response Information

GetFreeAgentInvitationMsgVMOutVO — { invitationMessage, errorMsg }

Response body formats

application/json, text/json

Sample:

{
  "invitationMessage": "sample string 1",
  "errorMsg": "sample string 2"
}

application/xml, text/xml

Sample:

<GetFreeAgentInvitationMsgVMOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.FreeAgent">
  <ErrorMsg>sample string 2</ErrorMsg>
  <InvitationMessage>sample string 1</InvitationMessage>
</GetFreeAgentInvitationMsgVMOutVO>

multipart/form-data

Sample:

Sample not available.