POST api/Lead

Inserts or updates lead information based on the provided request data.

Request Information

URI Parameters

None.

Body Parameters

The lead insert/update request data.

LeadInsertUpdateRequestModel
NameDescriptionTypeAdditional information
ApiToken

string

None.
LeadID

integer

None.
LeadCode

string

None.
Salutation

string

None.
FirstName

string

None.
LastName

string

None.
CompanyName

string

None.
Title

string

None.
EmailID

string

None.
SecondaryEmailID

string

None.
PhoneCode

string

None.
PhoneNumber

string

None.
MobileAreaCode

string

None.
MobileNumber

string

None.
LeadSourceID

integer

None.
LeadStatusID

integer

None.
LeadCategoryID

integer

None.
LeadIndustryID

integer

None.
LeadIndustryName

string

None.
LeadRatingID

integer

None.
LeadRatingName

string

None.
GSTINNumber

string

None.
PANNumber

string

None.
SkypeID

string

None.
Twitter

string

None.
Fax

string

None.
Website

string

None.
NoOfEmployees

integer

None.
AnnualRevenue

decimal number

None.
IsEmailOptOut

integer

None.
Address1

string

None.
Address2

string

None.
CountryID

integer

None.
StateID

integer

None.
CityID

integer

None.
Zipcode

string

None.
Custom1

string

None.
Custom2

string

None.
Custom3

string

None.
Custom4

string

None.
Custom5

string

None.
Custom6

string

None.
Custom7

string

None.
Custom8

string

None.
Custom9

string

None.
Custom10

string

None.
Description

string

None.
Notes

string

None.
LeadOwnerID

integer

None.
CurrencyID

integer

None.
IsActive

integer

None.
UserID

integer

None.
LeadShareOwnerIDs

string

None.
CustomerID

integer

None.
LocationID

integer

None.
SubLocationID

integer

None.

Request Formats

application/json, text/json, text/plain, text/html

Sample: 
{
  "apiToken": "sample string 1",
  "leadID": 2,
  "leadCode": "sample string 3",
  "salutation": "sample string 4",
  "firstName": "sample string 5",
  "lastName": "sample string 6",
  "companyName": "sample string 7",
  "title": "sample string 8",
  "emailID": "sample string 9",
  "secondaryEmailID": "sample string 10",
  "phoneCode": "sample string 11",
  "phoneNumber": "sample string 12",
  "mobileAreaCode": "sample string 13",
  "mobileNumber": "sample string 14",
  "leadSourceID": 1,
  "leadStatusID": 1,
  "leadCategoryID": 1,
  "leadIndustryID": 1,
  "leadIndustryName": "sample string 15",
  "leadRatingID": 1,
  "leadRatingName": "sample string 16",
  "gstinNumber": "sample string 17",
  "panNumber": "sample string 18",
  "skypeID": "sample string 19",
  "twitter": "sample string 20",
  "fax": "sample string 21",
  "website": "sample string 22",
  "noOfEmployees": 1,
  "annualRevenue": 1.0,
  "isEmailOptOut": 1,
  "address1": "sample string 23",
  "address2": "sample string 24",
  "countryID": 1,
  "stateID": 1,
  "cityID": 1,
  "zipcode": "sample string 25",
  "custom1": "sample string 26",
  "custom2": "sample string 27",
  "custom3": "sample string 28",
  "custom4": "sample string 29",
  "custom5": "sample string 30",
  "custom6": "sample string 31",
  "custom7": "sample string 32",
  "custom8": "sample string 33",
  "custom9": "sample string 34",
  "custom10": "sample string 35",
  "description": "sample string 36",
  "notes": "sample string 37",
  "leadOwnerID": 1,
  "currencyID": 1,
  "isActive": 38,
  "userID": 39,
  "leadShareOwnerIDs": "sample string 40",
  "customerID": 1,
  "locationID": 1,
  "subLocationID": 1
}

application/xml, text/xml

Sample: 
<LeadInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <Address1>sample string 23</Address1>
  <Address2>sample string 24</Address2>
  <AnnualRevenue>1</AnnualRevenue>
  <ApiToken>sample string 1</ApiToken>
  <CityID>1</CityID>
  <CompanyName>sample string 7</CompanyName>
  <CountryID>1</CountryID>
  <CurrencyID>1</CurrencyID>
  <Custom1>sample string 26</Custom1>
  <Custom10>sample string 35</Custom10>
  <Custom2>sample string 27</Custom2>
  <Custom3>sample string 28</Custom3>
  <Custom4>sample string 29</Custom4>
  <Custom5>sample string 30</Custom5>
  <Custom6>sample string 31</Custom6>
  <Custom7>sample string 32</Custom7>
  <Custom8>sample string 33</Custom8>
  <Custom9>sample string 34</Custom9>
  <CustomerID>1</CustomerID>
  <Description>sample string 36</Description>
  <EmailID>sample string 9</EmailID>
  <Fax>sample string 21</Fax>
  <FirstName>sample string 5</FirstName>
  <GSTINNumber>sample string 17</GSTINNumber>
  <IsActive>38</IsActive>
  <IsEmailOptOut>1</IsEmailOptOut>
  <LastName>sample string 6</LastName>
  <LeadCategoryID>1</LeadCategoryID>
  <LeadCode>sample string 3</LeadCode>
  <LeadID>2</LeadID>
  <LeadIndustryID>1</LeadIndustryID>
  <LeadIndustryName>sample string 15</LeadIndustryName>
  <LeadOwnerID>1</LeadOwnerID>
  <LeadRatingID>1</LeadRatingID>
  <LeadRatingName>sample string 16</LeadRatingName>
  <LeadShareOwnerIDs>sample string 40</LeadShareOwnerIDs>
  <LeadSourceID>1</LeadSourceID>
  <LeadStatusID>1</LeadStatusID>
  <LocationID>1</LocationID>
  <MobileAreaCode>sample string 13</MobileAreaCode>
  <MobileNumber>sample string 14</MobileNumber>
  <NoOfEmployees>1</NoOfEmployees>
  <Notes>sample string 37</Notes>
  <PANNumber>sample string 18</PANNumber>
  <PhoneCode>sample string 11</PhoneCode>
  <PhoneNumber>sample string 12</PhoneNumber>
  <Salutation>sample string 4</Salutation>
  <SecondaryEmailID>sample string 10</SecondaryEmailID>
  <SkypeID>sample string 19</SkypeID>
  <StateID>1</StateID>
  <SubLocationID>1</SubLocationID>
  <Title>sample string 8</Title>
  <Twitter>sample string 20</Twitter>
  <UserID>39</UserID>
  <Website>sample string 22</Website>
  <Zipcode>sample string 25</Zipcode>
</LeadInsertUpdateRequestModel>

multipart/form-data

Sample: 
<LeadInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><Address1>sample string 23</Address1><Address2>sample string 24</Address2><AnnualRevenue>1</AnnualRevenue><ApiToken>sample string 1</ApiToken><CityID>1</CityID><CompanyName>sample string 7</CompanyName><CountryID>1</CountryID><CurrencyID>1</CurrencyID><Custom1>sample string 26</Custom1><Custom10>sample string 35</Custom10><Custom2>sample string 27</Custom2><Custom3>sample string 28</Custom3><Custom4>sample string 29</Custom4><Custom5>sample string 30</Custom5><Custom6>sample string 31</Custom6><Custom7>sample string 32</Custom7><Custom8>sample string 33</Custom8><Custom9>sample string 34</Custom9><CustomerID>1</CustomerID><Description>sample string 36</Description><EmailID>sample string 9</EmailID><Fax>sample string 21</Fax><FirstName>sample string 5</FirstName><GSTINNumber>sample string 17</GSTINNumber><IsActive>38</IsActive><IsEmailOptOut>1</IsEmailOptOut><LastName>sample string 6</LastName><LeadCategoryID>1</LeadCategoryID><LeadCode>sample string 3</LeadCode><LeadID>2</LeadID><LeadIndustryID>1</LeadIndustryID><LeadIndustryName>sample string 15</LeadIndustryName><LeadOwnerID>1</LeadOwnerID><LeadRatingID>1</LeadRatingID><LeadRatingName>sample string 16</LeadRatingName><LeadShareOwnerIDs>sample string 40</LeadShareOwnerIDs><LeadSourceID>1</LeadSourceID><LeadStatusID>1</LeadStatusID><LocationID>1</LocationID><MobileAreaCode>sample string 13</MobileAreaCode><MobileNumber>sample string 14</MobileNumber><NoOfEmployees>1</NoOfEmployees><Notes>sample string 37</Notes><PANNumber>sample string 18</PANNumber><PhoneCode>sample string 11</PhoneCode><PhoneNumber>sample string 12</PhoneNumber><Salutation>sample string 4</Salutation><SecondaryEmailID>sample string 10</SecondaryEmailID><SkypeID>sample string 19</SkypeID><StateID>1</StateID><SubLocationID>1</SubLocationID><Title>sample string 8</Title><Twitter>sample string 20</Twitter><UserID>39</UserID><Website>sample string 22</Website><Zipcode>sample string 25</Zipcode></LeadInsertUpdateRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result of the insert/update operation.

CommonResponseDataModel
NameDescriptionTypeAdditional information
ReturnID

integer

Required
Message

string

Required
Successful

boolean

Required
Code

integer

None.
TotalRecord

integer

None.

Response Formats

application/json, text/json, text/plain, text/html

Sample: 
{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample: 
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample: 
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>