Documentation for POST api/rep/Create

POST api/rep/Create

This will add a new rep into Freedom. It will let you attempt placement within the genealogy. If UplineRepDID is left empty, the system will place the rep in the first available position under the sponsor. If UplineRepDID is given, we will attempt to place the rep at that exact position. This will return an error if that position is already filled.

Request Information

URI Parameters

None.

Body Parameters

CreateRepViewModel

Name	Type	Additional information
SponsorRepDID	string	Required
UplineRepDID	string	None.
BCPosition	string	None.
FirstName	string	None.
LastName	string	None.
MiddleInitial	string	Max length: 1
Company	string	None.
BillStreet1	string	None.
BillStreet2	string	None.
BillCity	string	None.
BillState	string	None.
BillPostalCode	string	None.
BillCounty	string	None.
BillCountry	string	None.
ShipStreet1	string	None.
ShipStreet2	string	None.
ShipCity	string	None.
ShipState	string	None.
ShipPostalCode	string	None.
ShipCounty	string	None.
ShipCountry	string	None.
Phone1	string	None.
Phone2	string	None.
Phone3	string	None.
Phone4	string	None.
Phone5	string	None.
Phone6	string	None.
JoinDate	date	None.
Email	string	None.
TaxID1	string	None.
TaxID2	string	None.
Password	string	None.
ReplicateURL	string	None.
RepTypeID	integer	None.
DateOfBirth	date	None.
DefaultLocaleID	integer	None.
PayoutMethodID	integer	None.
Gender	string	None.
IsTaxExempt	boolean	None.
TaxExemptCodeID	string	None.
OverrideRepDID	string	None.

Request Formats

application/xml, text/xml

Sample:

<CreateRepViewModel>
  <SponsorRepDID>sample string 1</SponsorRepDID>
  <UplineRepDID>sample string 2</UplineRepDID>
  <BCPosition>sample string 3</BCPosition>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <MiddleInitial>sample string 6</MiddleInitial>
  <Company>sample string 7</Company>
  <BillStreet1>sample string 8</BillStreet1>
  <BillStreet2>sample string 9</BillStreet2>
  <BillCity>sample string 10</BillCity>
  <BillState>sample string 11</BillState>
  <BillPostalCode>sample string 12</BillPostalCode>
  <BillCounty>sample string 13</BillCounty>
  <BillCountry>sample string 14</BillCountry>
  <ShipStreet1>sample string 15</ShipStreet1>
  <ShipStreet2>sample string 16</ShipStreet2>
  <ShipCity>sample string 17</ShipCity>
  <ShipState>sample string 18</ShipState>
  <ShipPostalCode>sample string 19</ShipPostalCode>
  <ShipCounty>sample string 20</ShipCounty>
  <ShipCountry>sample string 21</ShipCountry>
  <Phone1>sample string 22</Phone1>
  <Phone2>sample string 23</Phone2>
  <Phone3>sample string 24</Phone3>
  <Phone4>sample string 25</Phone4>
  <Phone5>sample string 26</Phone5>
  <Phone6>sample string 27</Phone6>
  <JoinDate>01/09/2025 01:38:35</JoinDate>
  <Email>sample string 28</Email>
  <TaxID1>sample string 29</TaxID1>
  <TaxID2>sample string 30</TaxID2>
  <Password>sample string 31</Password>
  <ReplicateURL>sample string 32</ReplicateURL>
  <RepTypeID>1</RepTypeID>
  <DateOfBirth>01/09/2025 01:38:35</DateOfBirth>
  <DefaultLocaleID>1</DefaultLocaleID>
  <PayoutMethodID>1</PayoutMethodID>
  <Gender>sample string 33</Gender>
  <IsTaxExempt>True</IsTaxExempt>
  <TaxExemptCodeID>sample string 35</TaxExemptCodeID>
  <OverrideRepDID>sample string 36</OverrideRepDID>
</CreateRepViewModel>

application/json, text/json

Sample:

{
  "SponsorRepDID": "sample string 1",
  "UplineRepDID": "sample string 2",
  "BCPosition": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "MiddleInitial": "sample string 6",
  "Company": "sample string 7",
  "BillStreet1": "sample string 8",
  "BillStreet2": "sample string 9",
  "BillCity": "sample string 10",
  "BillState": "sample string 11",
  "BillPostalCode": "sample string 12",
  "BillCounty": "sample string 13",
  "BillCountry": "sample string 14",
  "ShipStreet1": "sample string 15",
  "ShipStreet2": "sample string 16",
  "ShipCity": "sample string 17",
  "ShipState": "sample string 18",
  "ShipPostalCode": "sample string 19",
  "ShipCounty": "sample string 20",
  "ShipCountry": "sample string 21",
  "Phone1": "sample string 22",
  "Phone2": "sample string 23",
  "Phone3": "sample string 24",
  "Phone4": "sample string 25",
  "Phone5": "sample string 26",
  "Phone6": "sample string 27",
  "JoinDate": "2025-01-09T01:38:35.0267744-05:00",
  "Email": "sample string 28",
  "TaxID1": "sample string 29",
  "TaxID2": "sample string 30",
  "Password": "sample string 31",
  "ReplicateURL": "sample string 32",
  "RepTypeID": 1,
  "DateOfBirth": "2025-01-09T01:38:35.0267744-05:00",
  "DefaultLocaleID": 1,
  "PayoutMethodID": 1,
  "Gender": "sample string 33",
  "IsTaxExempt": true,
  "TaxExemptCodeID": "sample string 35",
  "OverrideRepDID": "sample string 36"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'CreateRepViewModel'.

Response Information

Resource Description

NewRepViewModel

Name	Description	Type	Additional information
Result		ApiResult	None.
RepDID		string	None.

Response Formats

application/xml, text/xml

Sample:

<NewRepViewModel>
  <Result />
  <RepDID>sample string 1</RepDID>
</NewRepViewModel>

application/json, text/json

Sample:

{
  "RepDID": "sample string 1"
}