PUT api/order/OnlineSignup?onlineSignupID={onlineSignupID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| onlineSignupID | integer |
Required |
Body Parameters
OnlineSignupViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The identifier of the online signup. |
integer |
None. |
| Guid |
The unique identifier. |
globally unique identifier |
None. |
| FirstName |
The first name of the enrollee. |
string |
None. |
| LastName |
The last name of the enrollee. |
string |
None. |
| Company |
The company name of the enrollee. Do not send when it is not a company. |
string |
None. |
| BillStreet1 |
The billing street1 of the enrollee. |
string |
None. |
| BillStreet2 |
The billing street2 of the enrollee. |
string |
None. |
| BillCity |
The billing city of the enrollee. |
string |
None. |
| BillState |
The billing state of the enrollee. |
string |
None. |
| BillPostalCode |
The billing postal code of the enrollee. |
string |
None. |
| BillCounty |
The billing county of the enrollee. |
string |
None. |
| BillCountry |
The billing country of the enrollee. |
string |
None. |
| ShipStreet1 |
The shipping street1 of the enrollee. |
string |
None. |
| ShipStreet2 |
The shipping street2 of the enrollee. |
string |
None. |
| ShipCity |
The shipping city of the enrollee. |
string |
None. |
| ShipState |
The shipping state of the enrollee. |
string |
None. |
| ShipPostalCode |
The shipping postal code of the enrollee. |
string |
None. |
| ShipCounty |
The shipping county of the enrollee. |
string |
None. |
| ShipCountry |
The shipping country of the enrollee. |
string |
None. |
|
The email of the enrollee. |
string |
None. |
|
| TaxID |
The tax identifier of the enrollee. |
string |
None. |
| Password |
The password of the enrollee. |
string |
None. |
| Phone1 |
The phone number 1 of the enrollee. |
string |
None. |
| Phone2 |
The phone number 2 of the enrollee. |
string |
None. |
| Phone3 |
The phone number 3 of the enrollee. |
string |
None. |
| Phone4 |
The phone number 4 of the enrollee. |
string |
None. |
| DateOfBirth |
The date of birth of the enrollee. |
date |
None. |
| PreferredCulture |
The preferred culture of the enrollee. This should be a valid Locale identifier. |
integer |
None. |
| UpgradeFromCustomerDID |
The customer identifier when the enrollee is a customer upgrading to a representative. |
string |
None. |
| MarketShowID |
The market show identifier. |
integer |
None. |
| UplineRepDID |
The upline rep identifier. When using holding tank feature you can pass the holding tank rep identifier. |
string |
None. |
| UplineBCDID |
Bussiness center identifier of the upline rep. Optional. Use it when you have the Multiple BC feature enabled. |
integer |
None. |
| Position |
Placement position. |
string |
None. |
| ReplicateURL |
URL associated with the new signup. |
string |
None. |
| RomanizedFirstName |
The romanized first name of the enrollee. |
string |
None. |
| RomanizedLastName |
The romanized last name of the enrollee. |
string |
None. |
| RomanizedCompany |
The romanized company name of the enrollee. Do not send when it is not a company. |
string |
None. |
| SponsorRepID |
The SponsorRepID of the online signup. |
integer |
None. |
| OnlineSignupMisc |
For any customizations, this holds the extra fields associated to customizations. |
Collection of MiscFieldViewModel |
None. |
Request Formats
application/xml, text/xml
<OnlineSignupViewModel>
<ID>1</ID>
<Guid>1449ea5e-0dd1-4a83-a4f5-7459829d9759</Guid>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Company>sample string 5</Company>
<BillStreet1>sample string 6</BillStreet1>
<BillStreet2>sample string 7</BillStreet2>
<BillCity>sample string 8</BillCity>
<BillState>sample string 9</BillState>
<BillPostalCode>sample string 10</BillPostalCode>
<BillCounty>sample string 11</BillCounty>
<BillCountry>sample string 12</BillCountry>
<ShipStreet1>sample string 13</ShipStreet1>
<ShipStreet2>sample string 14</ShipStreet2>
<ShipCity>sample string 15</ShipCity>
<ShipState>sample string 16</ShipState>
<ShipPostalCode>sample string 17</ShipPostalCode>
<ShipCounty>sample string 18</ShipCounty>
<ShipCountry>sample string 19</ShipCountry>
<Email>sample string 20</Email>
<TaxID>sample string 21</TaxID>
<Password>sample string 22</Password>
<Phone1>sample string 23</Phone1>
<Phone2>sample string 24</Phone2>
<Phone3>sample string 25</Phone3>
<Phone4>sample string 26</Phone4>
<DateOfBirth>10/28/2025 17:40:27</DateOfBirth>
<PreferredCulture>27</PreferredCulture>
<UpgradeFromCustomerDID>sample string 28</UpgradeFromCustomerDID>
<MarketShowID>1</MarketShowID>
<UplineRepDID>sample string 29</UplineRepDID>
<UplineBCDID>1</UplineBCDID>
<Position>sample string 30</Position>
<ReplicateURL>sample string 31</ReplicateURL>
<RomanizedFirstName>sample string 32</RomanizedFirstName>
<RomanizedLastName>sample string 33</RomanizedLastName>
<RomanizedCompany>sample string 34</RomanizedCompany>
<SponsorRepID>35</SponsorRepID>
<OnlineSignupMisc>
<MiscFieldViewModel>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</MiscFieldViewModel>
<MiscFieldViewModel>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</MiscFieldViewModel>
</OnlineSignupMisc>
</OnlineSignupViewModel>
application/json, text/json
{
"ID": 1,
"Guid": "1449ea5e-0dd1-4a83-a4f5-7459829d9759",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Company": "sample string 5",
"BillStreet1": "sample string 6",
"BillStreet2": "sample string 7",
"BillCity": "sample string 8",
"BillState": "sample string 9",
"BillPostalCode": "sample string 10",
"BillCounty": "sample string 11",
"BillCountry": "sample string 12",
"ShipStreet1": "sample string 13",
"ShipStreet2": "sample string 14",
"ShipCity": "sample string 15",
"ShipState": "sample string 16",
"ShipPostalCode": "sample string 17",
"ShipCounty": "sample string 18",
"ShipCountry": "sample string 19",
"Email": "sample string 20",
"TaxID": "sample string 21",
"Password": "sample string 22",
"Phone1": "sample string 23",
"Phone2": "sample string 24",
"Phone3": "sample string 25",
"Phone4": "sample string 26",
"DateOfBirth": "2025-10-28T17:40:27.7091451-04:00",
"PreferredCulture": 27,
"UpgradeFromCustomerDID": "sample string 28",
"MarketShowID": 1,
"UplineRepDID": "sample string 29",
"UplineBCDID": 1,
"Position": "sample string 30",
"ReplicateURL": "sample string 31",
"RomanizedFirstName": "sample string 32",
"RomanizedLastName": "sample string 33",
"RomanizedCompany": "sample string 34",
"SponsorRepID": 35,
"OnlineSignupMisc": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}
application/x-www-form-urlencoded
Response Information
Resource Description
OnlineSignupViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The identifier of the online signup. |
integer |
None. |
| Guid |
The unique identifier. |
globally unique identifier |
None. |
| FirstName |
The first name of the enrollee. |
string |
None. |
| LastName |
The last name of the enrollee. |
string |
None. |
| Company |
The company name of the enrollee. Do not send when it is not a company. |
string |
None. |
| BillStreet1 |
The billing street1 of the enrollee. |
string |
None. |
| BillStreet2 |
The billing street2 of the enrollee. |
string |
None. |
| BillCity |
The billing city of the enrollee. |
string |
None. |
| BillState |
The billing state of the enrollee. |
string |
None. |
| BillPostalCode |
The billing postal code of the enrollee. |
string |
None. |
| BillCounty |
The billing county of the enrollee. |
string |
None. |
| BillCountry |
The billing country of the enrollee. |
string |
None. |
| ShipStreet1 |
The shipping street1 of the enrollee. |
string |
None. |
| ShipStreet2 |
The shipping street2 of the enrollee. |
string |
None. |
| ShipCity |
The shipping city of the enrollee. |
string |
None. |
| ShipState |
The shipping state of the enrollee. |
string |
None. |
| ShipPostalCode |
The shipping postal code of the enrollee. |
string |
None. |
| ShipCounty |
The shipping county of the enrollee. |
string |
None. |
| ShipCountry |
The shipping country of the enrollee. |
string |
None. |
|
The email of the enrollee. |
string |
None. |
|
| TaxID |
The tax identifier of the enrollee. |
string |
None. |
| Password |
The password of the enrollee. |
string |
None. |
| Phone1 |
The phone number 1 of the enrollee. |
string |
None. |
| Phone2 |
The phone number 2 of the enrollee. |
string |
None. |
| Phone3 |
The phone number 3 of the enrollee. |
string |
None. |
| Phone4 |
The phone number 4 of the enrollee. |
string |
None. |
| DateOfBirth |
The date of birth of the enrollee. |
date |
None. |
| PreferredCulture |
The preferred culture of the enrollee. This should be a valid Locale identifier. |
integer |
None. |
| UpgradeFromCustomerDID |
The customer identifier when the enrollee is a customer upgrading to a representative. |
string |
None. |
| MarketShowID |
The market show identifier. |
integer |
None. |
| UplineRepDID |
The upline rep identifier. When using holding tank feature you can pass the holding tank rep identifier. |
string |
None. |
| UplineBCDID |
Bussiness center identifier of the upline rep. Optional. Use it when you have the Multiple BC feature enabled. |
integer |
None. |
| Position |
Placement position. |
string |
None. |
| ReplicateURL |
URL associated with the new signup. |
string |
None. |
| RomanizedFirstName |
The romanized first name of the enrollee. |
string |
None. |
| RomanizedLastName |
The romanized last name of the enrollee. |
string |
None. |
| RomanizedCompany |
The romanized company name of the enrollee. Do not send when it is not a company. |
string |
None. |
| SponsorRepID |
The SponsorRepID of the online signup. |
integer |
None. |
| OnlineSignupMisc |
For any customizations, this holds the extra fields associated to customizations. |
Collection of MiscFieldViewModel |
None. |
Response Formats
application/xml, text/xml
<OnlineSignupViewModel>
<ID>1</ID>
<Guid>6e8d305f-49b1-46cd-824d-5747432286f9</Guid>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Company>sample string 5</Company>
<BillStreet1>sample string 6</BillStreet1>
<BillStreet2>sample string 7</BillStreet2>
<BillCity>sample string 8</BillCity>
<BillState>sample string 9</BillState>
<BillPostalCode>sample string 10</BillPostalCode>
<BillCounty>sample string 11</BillCounty>
<BillCountry>sample string 12</BillCountry>
<ShipStreet1>sample string 13</ShipStreet1>
<ShipStreet2>sample string 14</ShipStreet2>
<ShipCity>sample string 15</ShipCity>
<ShipState>sample string 16</ShipState>
<ShipPostalCode>sample string 17</ShipPostalCode>
<ShipCounty>sample string 18</ShipCounty>
<ShipCountry>sample string 19</ShipCountry>
<Email>sample string 20</Email>
<TaxID>sample string 21</TaxID>
<Password>sample string 22</Password>
<Phone1>sample string 23</Phone1>
<Phone2>sample string 24</Phone2>
<Phone3>sample string 25</Phone3>
<Phone4>sample string 26</Phone4>
<DateOfBirth>10/28/2025 17:40:27</DateOfBirth>
<PreferredCulture>27</PreferredCulture>
<UpgradeFromCustomerDID>sample string 28</UpgradeFromCustomerDID>
<MarketShowID>1</MarketShowID>
<UplineRepDID>sample string 29</UplineRepDID>
<UplineBCDID>1</UplineBCDID>
<Position>sample string 30</Position>
<ReplicateURL>sample string 31</ReplicateURL>
<RomanizedFirstName>sample string 32</RomanizedFirstName>
<RomanizedLastName>sample string 33</RomanizedLastName>
<RomanizedCompany>sample string 34</RomanizedCompany>
<SponsorRepID>35</SponsorRepID>
<OnlineSignupMisc>
<MiscFieldViewModel>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</MiscFieldViewModel>
<MiscFieldViewModel>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</MiscFieldViewModel>
</OnlineSignupMisc>
</OnlineSignupViewModel>
application/json, text/json
{
"ID": 1,
"Guid": "6e8d305f-49b1-46cd-824d-5747432286f9",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Company": "sample string 5",
"BillStreet1": "sample string 6",
"BillStreet2": "sample string 7",
"BillCity": "sample string 8",
"BillState": "sample string 9",
"BillPostalCode": "sample string 10",
"BillCounty": "sample string 11",
"BillCountry": "sample string 12",
"ShipStreet1": "sample string 13",
"ShipStreet2": "sample string 14",
"ShipCity": "sample string 15",
"ShipState": "sample string 16",
"ShipPostalCode": "sample string 17",
"ShipCounty": "sample string 18",
"ShipCountry": "sample string 19",
"Email": "sample string 20",
"TaxID": "sample string 21",
"Password": "sample string 22",
"Phone1": "sample string 23",
"Phone2": "sample string 24",
"Phone3": "sample string 25",
"Phone4": "sample string 26",
"DateOfBirth": "2025-10-28T17:40:27.7091451-04:00",
"PreferredCulture": 27,
"UpgradeFromCustomerDID": "sample string 28",
"MarketShowID": 1,
"UplineRepDID": "sample string 29",
"UplineBCDID": 1,
"Position": "sample string 30",
"ReplicateURL": "sample string 31",
"RomanizedFirstName": "sample string 32",
"RomanizedLastName": "sample string 33",
"RomanizedCompany": "sample string 34",
"SponsorRepID": 35,
"OnlineSignupMisc": [
{
"Name": "sample string 1",
"Value": "sample string 2"
},
{
"Name": "sample string 1",
"Value": "sample string 2"
}
]
}