POST api/Lead/AddLead

Inserts new lead information based on the provided request data.

Request Information

URI Parameters

None.

Body Parameters

The lead insert request data.

Name	Type	Additional information
ApiToken	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.
Fax	string	None.
Website	string	None.
LeadCategory	string	None.
LeadIndustry	string	None.
LeadSource	string	None.
AnnualRevenue	decimal number	None.
NoOfEmployees	integer	None.
Address1	string	None.
Address2	string	None.
Country	string	None.
State	string	None.
City	string	None.
Zipcode	string	None.
Description	string	None.
Notes	string	None.
CustomerCompany	string	None.

Request Formats

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

Sample:

{
  "apiToken": "sample string 1",
  "salutation": "sample string 2",
  "firstName": "sample string 3",
  "lastName": "sample string 4",
  "companyName": "sample string 5",
  "title": "sample string 6",
  "emailID": "sample string 7",
  "secondaryEmailID": "sample string 8",
  "phoneCode": "sample string 9",
  "phoneNumber": "sample string 10",
  "mobileAreaCode": "sample string 11",
  "mobileNumber": "sample string 12",
  "fax": "sample string 13",
  "website": "sample string 14",
  "leadCategory": "sample string 15",
  "leadIndustry": "sample string 16",
  "leadSource": "sample string 17",
  "annualRevenue": 1.0,
  "noOfEmployees": 1,
  "address1": "sample string 18",
  "address2": "sample string 19",
  "country": "sample string 20",
  "state": "sample string 21",
  "city": "sample string 22",
  "zipcode": "sample string 23",
  "description": "sample string 24",
  "notes": "sample string 25",
  "customerCompany": "sample string 26"
}

application/xml, text/xml

Sample:

<LeadInsertRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <Address1>sample string 18</Address1>
  <Address2>sample string 19</Address2>
  <AnnualRevenue>1</AnnualRevenue>
  <ApiToken>sample string 1</ApiToken>
  <City>sample string 22</City>
  <CompanyName>sample string 5</CompanyName>
  <Country>sample string 20</Country>
  <CustomerCompany>sample string 26</CustomerCompany>
  <Description>sample string 24</Description>
  <EmailID>sample string 7</EmailID>
  <Fax>sample string 13</Fax>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <LeadCategory>sample string 15</LeadCategory>
  <LeadIndustry>sample string 16</LeadIndustry>
  <LeadSource>sample string 17</LeadSource>
  <MobileAreaCode>sample string 11</MobileAreaCode>
  <MobileNumber>sample string 12</MobileNumber>
  <NoOfEmployees>1</NoOfEmployees>
  <Notes>sample string 25</Notes>
  <PhoneCode>sample string 9</PhoneCode>
  <PhoneNumber>sample string 10</PhoneNumber>
  <Salutation>sample string 2</Salutation>
  <SecondaryEmailID>sample string 8</SecondaryEmailID>
  <State>sample string 21</State>
  <Title>sample string 6</Title>
  <Website>sample string 14</Website>
  <Zipcode>sample string 23</Zipcode>
</LeadInsertRequestModel>

multipart/form-data

Sample:

<LeadInsertRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><Address1>sample string 18</Address1><Address2>sample string 19</Address2><AnnualRevenue>1</AnnualRevenue><ApiToken>sample string 1</ApiToken><City>sample string 22</City><CompanyName>sample string 5</CompanyName><Country>sample string 20</Country><CustomerCompany>sample string 26</CustomerCompany><Description>sample string 24</Description><EmailID>sample string 7</EmailID><Fax>sample string 13</Fax><FirstName>sample string 3</FirstName><LastName>sample string 4</LastName><LeadCategory>sample string 15</LeadCategory><LeadIndustry>sample string 16</LeadIndustry><LeadSource>sample string 17</LeadSource><MobileAreaCode>sample string 11</MobileAreaCode><MobileNumber>sample string 12</MobileNumber><NoOfEmployees>1</NoOfEmployees><Notes>sample string 25</Notes><PhoneCode>sample string 9</PhoneCode><PhoneNumber>sample string 10</PhoneNumber><Salutation>sample string 2</Salutation><SecondaryEmailID>sample string 8</SecondaryEmailID><State>sample string 21</State><Title>sample string 6</Title><Website>sample string 14</Website><Zipcode>sample string 23</Zipcode></LeadInsertRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result of the insert operation.

CommonResponseDataModel

Name	Type	Additional 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>