URL
https://devwebapi.leadmaster.com/api/Automation/AddOpportunity
Description
Add the opportunity with user selected products..
HttpMethod
POST
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| request | The request. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"access_token": "sample string 1",
"lstOpportunityProduct": [
{
"OppID": 1,
"AvailProductID": 2,
"UnitPrice": 3.0,
"Quantity": 4.0,
"ProductTotal": 5.0,
"Recur": 6,
"NumOfRecur": 7,
"Discount": 8.1,
"RecurEndDate": "2025-10-31T20:38:33.7653218-04:00",
"LastUpdated": "2025-10-31T20:38:33.7653218-04:00",
"UpdatedBy": "sample string 10",
"ProductCode": "sample string 11",
"ProductNumber": "sample string 12",
"ProductDesc": "sample string 13",
"CustomC1": "sample string 14",
"CustomD1": "2025-10-31T20:38:33.7653218-04:00",
"CustomI1": 15,
"CustomM1": 16.0,
"CustomN1": 17.0,
"nQuantity": 18.0,
"CommissionPercentage": 19.1,
"CommissionValue": 20.0,
"Commission": 21.0,
"BaseCost": 22.0,
"CommissionType": 23,
"CommissionMethod": 24,
"TaxCode": "sample string 25",
"isActive": true,
"isTaxable": true,
"CustomD2": "2025-10-31T20:38:33.7653218-04:00",
"CustomC2": "sample string 28",
"RequiredToSync": 29,
"UOM_Type": "sample string 30",
"UOM_Qty": 31.0,
"SyncToQB": 32,
"CustomC3": "sample string 33",
"CustomC4": "sample string 34",
"CustomC5": "sample string 35",
"CustomC6": "sample string 36"
},
{
"OppID": 1,
"AvailProductID": 2,
"UnitPrice": 3.0,
"Quantity": 4.0,
"ProductTotal": 5.0,
"Recur": 6,
"NumOfRecur": 7,
"Discount": 8.1,
"RecurEndDate": "2025-10-31T20:38:33.7653218-04:00",
"LastUpdated": "2025-10-31T20:38:33.7653218-04:00",
"UpdatedBy": "sample string 10",
"ProductCode": "sample string 11",
"ProductNumber": "sample string 12",
"ProductDesc": "sample string 13",
"CustomC1": "sample string 14",
"CustomD1": "2025-10-31T20:38:33.7653218-04:00",
"CustomI1": 15,
"CustomM1": 16.0,
"CustomN1": 17.0,
"nQuantity": 18.0,
"CommissionPercentage": 19.1,
"CommissionValue": 20.0,
"Commission": 21.0,
"BaseCost": 22.0,
"CommissionType": 23,
"CommissionMethod": 24,
"TaxCode": "sample string 25",
"isActive": true,
"isTaxable": true,
"CustomD2": "2025-10-31T20:38:33.7653218-04:00",
"CustomC2": "sample string 28",
"RequiredToSync": 29,
"UOM_Type": "sample string 30",
"UOM_Qty": 31.0,
"SyncToQB": 32,
"CustomC3": "sample string 33",
"CustomC4": "sample string 34",
"CustomC5": "sample string 35",
"CustomC6": "sample string 36"
},
{
"OppID": 1,
"AvailProductID": 2,
"UnitPrice": 3.0,
"Quantity": 4.0,
"ProductTotal": 5.0,
"Recur": 6,
"NumOfRecur": 7,
"Discount": 8.1,
"RecurEndDate": "2025-10-31T20:38:33.7653218-04:00",
"LastUpdated": "2025-10-31T20:38:33.7653218-04:00",
"UpdatedBy": "sample string 10",
"ProductCode": "sample string 11",
"ProductNumber": "sample string 12",
"ProductDesc": "sample string 13",
"CustomC1": "sample string 14",
"CustomD1": "2025-10-31T20:38:33.7653218-04:00",
"CustomI1": 15,
"CustomM1": 16.0,
"CustomN1": 17.0,
"nQuantity": 18.0,
"CommissionPercentage": 19.1,
"CommissionValue": 20.0,
"Commission": 21.0,
"BaseCost": 22.0,
"CommissionType": 23,
"CommissionMethod": 24,
"TaxCode": "sample string 25",
"isActive": true,
"isTaxable": true,
"CustomD2": "2025-10-31T20:38:33.7653218-04:00",
"CustomC2": "sample string 28",
"RequiredToSync": 29,
"UOM_Type": "sample string 30",
"UOM_Qty": 31.0,
"SyncToQB": 32,
"CustomC3": "sample string 33",
"CustomC4": "sample string 34",
"CustomC5": "sample string 35",
"CustomC6": "sample string 36"
}
],
"RecordID": 2,
"RECDNO": 3,
"OppName": "sample string 4",
"OppDesc": "sample string 5",
"SalesStatus": "sample string 6",
"ForecastDate": "2025-10-31T20:38:33.7653218-04:00",
"WinProbability": 7.1,
"NumOfHourWork": 8.1,
"NumOfHourTravel": 9.1,
"OppSource": "sample string 10",
"CloseDate": "2025-10-31T20:38:33.7653218-04:00",
"SalesStage": "sample string 11",
"CloseReason": "sample string 12",
"Custom0": "sample string 13",
"Custom1": "sample string 14",
"Custom2": "sample string 15",
"Custom3": "sample string 16",
"Custom4": "sample string 17",
"OppNote": "sample string 18",
"OppTotal": 19.0,
"TotalQuantity": 20,
"ContactID": 21,
"DateCreated": "2025-10-31T20:38:33.7653218-04:00",
"LastUpdated": "2025-10-31T20:38:33.7653218-04:00",
"Edited": "2025-10-31T20:38:33.7653218-04:00",
"UpdatedBy": "sample string 22",
"OppType": "sample string 23",
"Custom5": 24.0,
"Custom6": "2025-10-31T20:38:33.7653218-04:00",
"Custom7": 25.0,
"otherRECDNO": 26.0,
"Reassign": 27,
"User_Field_1": "sample string 28",
"User_Field_2": "sample string 29",
"User_Field_3": "sample string 30",
"User_Field_4": "sample string 31",
"User_Field_5": "sample string 32",
"User_Field_6": "sample string 33",
"User_Field_7": "sample string 34",
"User_Field_8": "sample string 35",
"dUser_Field_1": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_2": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_3": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_4": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_5": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_6": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_7": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_8": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_9": "2025-10-31T20:38:33.7653218-04:00",
"dUser_Field_10": "2025-10-31T20:38:33.7653218-04:00",
"iUser_Field_1": 36,
"iUser_Field_2": 37,
"iUser_Field_3": 38,
"iUser_Field_4": 39,
"iUser_Field_5": 40,
"iUser_Field_6": 41,
"iUser_Field_7": 42,
"iUser_Field_8": 43,
"iUser_Field_9": 44,
"iUser_Field_10": 45,
"QBInvoiceId": 46,
"ImportKey": "sample string 47",
"User_Field_9": "sample string 48",
"Discount": "sample string 49",
"OppContactsID2": 50,
"referralRECDNO": 51,
"referralContactID": 52,
"referralOppID": 53,
"OppReferralName": "sample string 54"
}
application/xml, text/xml
Sample:
<TypeOpportunityData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects.ViewModel">
<CloseDate>2025-10-31T20:38:33.7653218-04:00</CloseDate>
<CloseReason>sample string 12</CloseReason>
<ContactID>21</ContactID>
<Custom0>sample string 13</Custom0>
<Custom1>sample string 14</Custom1>
<Custom2>sample string 15</Custom2>
<Custom3>sample string 16</Custom3>
<Custom4>sample string 17</Custom4>
<Custom5>24</Custom5>
<Custom6>2025-10-31T20:38:33.7653218-04:00</Custom6>
<Custom7>25</Custom7>
<DateCreated>2025-10-31T20:38:33.7653218-04:00</DateCreated>
<Discount>sample string 49</Discount>
<Edited>2025-10-31T20:38:33.7653218-04:00</Edited>
<ForecastDate>2025-10-31T20:38:33.7653218-04:00</ForecastDate>
<ImportKey>sample string 47</ImportKey>
<LastUpdated>2025-10-31T20:38:33.7653218-04:00</LastUpdated>
<NumOfHourTravel>9.1</NumOfHourTravel>
<NumOfHourWork>8.1</NumOfHourWork>
<OppContactsID2>50</OppContactsID2>
<OppDesc>sample string 5</OppDesc>
<OppName>sample string 4</OppName>
<OppNote>sample string 18</OppNote>
<OppReferralName>sample string 54</OppReferralName>
<OppSource>sample string 10</OppSource>
<OppTotal>19</OppTotal>
<OppType>sample string 23</OppType>
<QBInvoiceId>46</QBInvoiceId>
<RECDNO>3</RECDNO>
<Reassign>27</Reassign>
<RecordID>2</RecordID>
<SalesStage>sample string 11</SalesStage>
<SalesStatus>sample string 6</SalesStatus>
<TotalQuantity>20</TotalQuantity>
<UpdatedBy>sample string 22</UpdatedBy>
<User_Field_1>sample string 28</User_Field_1>
<User_Field_2>sample string 29</User_Field_2>
<User_Field_3>sample string 30</User_Field_3>
<User_Field_4>sample string 31</User_Field_4>
<User_Field_5>sample string 32</User_Field_5>
<User_Field_6>sample string 33</User_Field_6>
<User_Field_7>sample string 34</User_Field_7>
<User_Field_8>sample string 35</User_Field_8>
<User_Field_9>sample string 48</User_Field_9>
<WinProbability>7.1</WinProbability>
<dUser_Field_1>2025-10-31T20:38:33.7653218-04:00</dUser_Field_1>
<dUser_Field_10>2025-10-31T20:38:33.7653218-04:00</dUser_Field_10>
<dUser_Field_2>2025-10-31T20:38:33.7653218-04:00</dUser_Field_2>
<dUser_Field_3>2025-10-31T20:38:33.7653218-04:00</dUser_Field_3>
<dUser_Field_4>2025-10-31T20:38:33.7653218-04:00</dUser_Field_4>
<dUser_Field_5>2025-10-31T20:38:33.7653218-04:00</dUser_Field_5>
<dUser_Field_6>2025-10-31T20:38:33.7653218-04:00</dUser_Field_6>
<dUser_Field_7>2025-10-31T20:38:33.7653218-04:00</dUser_Field_7>
<dUser_Field_8>2025-10-31T20:38:33.7653218-04:00</dUser_Field_8>
<dUser_Field_9>2025-10-31T20:38:33.7653218-04:00</dUser_Field_9>
<iUser_Field_1>36</iUser_Field_1>
<iUser_Field_10>45</iUser_Field_10>
<iUser_Field_2>37</iUser_Field_2>
<iUser_Field_3>38</iUser_Field_3>
<iUser_Field_4>39</iUser_Field_4>
<iUser_Field_5>40</iUser_Field_5>
<iUser_Field_6>41</iUser_Field_6>
<iUser_Field_7>42</iUser_Field_7>
<iUser_Field_8>43</iUser_Field_8>
<iUser_Field_9>44</iUser_Field_9>
<otherRECDNO>26</otherRECDNO>
<referralContactID>52</referralContactID>
<referralOppID>53</referralOppID>
<referralRECDNO>51</referralRECDNO>
<access_token>sample string 1</access_token>
<lstOpportunityProduct>
<ClsOpportunityProduct>
<AvailProductID>2</AvailProductID>
<BaseCost>22</BaseCost>
<Commission>21</Commission>
<CommissionMethod>24</CommissionMethod>
<CommissionPercentage>19.1</CommissionPercentage>
<CommissionType>23</CommissionType>
<CommissionValue>20</CommissionValue>
<CustomC1>sample string 14</CustomC1>
<CustomC2>sample string 28</CustomC2>
<CustomC3>sample string 33</CustomC3>
<CustomC4>sample string 34</CustomC4>
<CustomC5>sample string 35</CustomC5>
<CustomC6>sample string 36</CustomC6>
<CustomD1>2025-10-31T20:38:33.7653218-04:00</CustomD1>
<CustomD2>2025-10-31T20:38:33.7653218-04:00</CustomD2>
<CustomI1>15</CustomI1>
<CustomM1>16</CustomM1>
<CustomN1>17</CustomN1>
<Discount>8.1</Discount>
<LastUpdated>2025-10-31T20:38:33.7653218-04:00</LastUpdated>
<NumOfRecur>7</NumOfRecur>
<OppID>1</OppID>
<ProductCode>sample string 11</ProductCode>
<ProductDesc>sample string 13</ProductDesc>
<ProductNumber>sample string 12</ProductNumber>
<ProductTotal>5</ProductTotal>
<Quantity>4</Quantity>
<Recur>6</Recur>
<RecurEndDate>2025-10-31T20:38:33.7653218-04:00</RecurEndDate>
<RequiredToSync>29</RequiredToSync>
<SyncToQB>32</SyncToQB>
<TaxCode>sample string 25</TaxCode>
<UOM_Qty>31</UOM_Qty>
<UOM_Type>sample string 30</UOM_Type>
<UnitPrice>3</UnitPrice>
<UpdatedBy>sample string 10</UpdatedBy>
<isActive>true</isActive>
<isTaxable>true</isTaxable>
<nQuantity>18</nQuantity>
</ClsOpportunityProduct>
<ClsOpportunityProduct>
<AvailProductID>2</AvailProductID>
<BaseCost>22</BaseCost>
<Commission>21</Commission>
<CommissionMethod>24</CommissionMethod>
<CommissionPercentage>19.1</CommissionPercentage>
<CommissionType>23</CommissionType>
<CommissionValue>20</CommissionValue>
<CustomC1>sample string 14</CustomC1>
<CustomC2>sample string 28</CustomC2>
<CustomC3>sample string 33</CustomC3>
<CustomC4>sample string 34</CustomC4>
<CustomC5>sample string 35</CustomC5>
<CustomC6>sample string 36</CustomC6>
<CustomD1>2025-10-31T20:38:33.7653218-04:00</CustomD1>
<CustomD2>2025-10-31T20:38:33.7653218-04:00</CustomD2>
<CustomI1>15</CustomI1>
<CustomM1>16</CustomM1>
<CustomN1>17</CustomN1>
<Discount>8.1</Discount>
<LastUpdated>2025-10-31T20:38:33.7653218-04:00</LastUpdated>
<NumOfRecur>7</NumOfRecur>
<OppID>1</OppID>
<ProductCode>sample string 11</ProductCode>
<ProductDesc>sample string 13</ProductDesc>
<ProductNumber>sample string 12</ProductNumber>
<ProductTotal>5</ProductTotal>
<Quantity>4</Quantity>
<Recur>6</Recur>
<RecurEndDate>2025-10-31T20:38:33.7653218-04:00</RecurEndDate>
<RequiredToSync>29</RequiredToSync>
<SyncToQB>32</SyncToQB>
<TaxCode>sample string 25</TaxCode>
<UOM_Qty>31</UOM_Qty>
<UOM_Type>sample string 30</UOM_Type>
<UnitPrice>3</UnitPrice>
<UpdatedBy>sample string 10</UpdatedBy>
<isActive>true</isActive>
<isTaxable>true</isTaxable>
<nQuantity>18</nQuantity>
</ClsOpportunityProduct>
<ClsOpportunityProduct>
<AvailProductID>2</AvailProductID>
<BaseCost>22</BaseCost>
<Commission>21</Commission>
<CommissionMethod>24</CommissionMethod>
<CommissionPercentage>19.1</CommissionPercentage>
<CommissionType>23</CommissionType>
<CommissionValue>20</CommissionValue>
<CustomC1>sample string 14</CustomC1>
<CustomC2>sample string 28</CustomC2>
<CustomC3>sample string 33</CustomC3>
<CustomC4>sample string 34</CustomC4>
<CustomC5>sample string 35</CustomC5>
<CustomC6>sample string 36</CustomC6>
<CustomD1>2025-10-31T20:38:33.7653218-04:00</CustomD1>
<CustomD2>2025-10-31T20:38:33.7653218-04:00</CustomD2>
<CustomI1>15</CustomI1>
<CustomM1>16</CustomM1>
<CustomN1>17</CustomN1>
<Discount>8.1</Discount>
<LastUpdated>2025-10-31T20:38:33.7653218-04:00</LastUpdated>
<NumOfRecur>7</NumOfRecur>
<OppID>1</OppID>
<ProductCode>sample string 11</ProductCode>
<ProductDesc>sample string 13</ProductDesc>
<ProductNumber>sample string 12</ProductNumber>
<ProductTotal>5</ProductTotal>
<Quantity>4</Quantity>
<Recur>6</Recur>
<RecurEndDate>2025-10-31T20:38:33.7653218-04:00</RecurEndDate>
<RequiredToSync>29</RequiredToSync>
<SyncToQB>32</SyncToQB>
<TaxCode>sample string 25</TaxCode>
<UOM_Qty>31</UOM_Qty>
<UOM_Type>sample string 30</UOM_Type>
<UnitPrice>3</UnitPrice>
<UpdatedBy>sample string 10</UpdatedBy>
<isActive>true</isActive>
<isTaxable>true</isTaxable>
<nQuantity>18</nQuantity>
</ClsOpportunityProduct>
</lstOpportunityProduct>
</TypeOpportunityData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{
"StatusCode": 100,
"IsSuccess": true,
"Message": "sample string 2",
"Result": "sample string 3"
}
application/xml, text/xml
Sample:
<APIResponseBaseOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects.ViewModel"> <IsSuccess>true</IsSuccess> <Message>sample string 2</Message> <Result>sample string 3</Result> <StatusCode>Continue</StatusCode> </APIResponseBaseOfstring>