POST api/sales/lead/new?token={token}

Create a new lead

Request Information

URI Parameters

Name	Description	Type	Additional information
token		string	Required

Body Parameters

LeadNewData

Name	Description	Type	Additional information
LeadID	Pass 0 for new lead	integer	None.
EnquryDateTime		date	Data type: DateTime
LocationSought		string	None.
OfferedLocationID	Site id of offered location or 0	integer	Required
Product		string	Required
NoOfPeople		integer	None.
ExpectedStartDate		date	Required Data type: Date
TermMonths	Initial contract period in months	integer	None.
LeadStatusID		integer	None.
LeadManagerID	User id for the lead manager	integer	None.
Budget	If any budget restriction	string	None.
Source	Lead source	string	None.
BrokerNotes	max 500 characters	string	None.
BrokerContact		string	None.
BrokerEmail		string	None.
BrokerRefNo	Broker reference number	string	None.
Contact		ContactData	None.
CreateATask		boolean	None.
Task		TaskData	None.

Request Formats

application/json, text/json

Sample:

{
  "LeadID": 1,
  "EnquryDateTime": "2026-01-08T11:19:41.6522306+00:00",
  "LocationSought": "sample string 3",
  "OfferedLocationID": 4,
  "Product": "sample string 5",
  "NoOfPeople": 6,
  "ExpectedStartDate": "2026-01-08T11:19:41.6522306+00:00",
  "TermMonths": 8,
  "LeadStatusID": 9,
  "LeadManagerID": 10,
  "Budget": "sample string 11",
  "Source": "sample string 12",
  "BrokerNotes": "sample string 13",
  "BrokerContact": "sample string 14",
  "BrokerEmail": "sample string 15",
  "BrokerRefNo": "sample string 16",
  "Contact": {
    "CompanyName": "sample string 1",
    "Title": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "BusinessRole": "sample string 5",
    "Email": "sample string 6",
    "Phone": "sample string 7",
    "Mobile": "sample string 8",
    "AddressLine1": "sample string 9",
    "AddressLine2": "sample string 10",
    "City": "sample string 11",
    "CountyOrState": "sample string 12",
    "PostOrZipCode": "sample string 13",
    "Country": "sample string 14"
  },
  "CreateATask": true,
  "Task": {
    "TaskID": 1,
    "LeadID": 2,
    "TaskTypeID": 3,
    "TaskForUserID": 4,
    "TaskDateTime": "2026-01-08T11:19:41.6678317+00:00",
    "Completed": true,
    "Cancelled": true,
    "Important": true,
    "TaskNote": "sample string 9",
    "TaskLocation": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<LeadNewData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UltraSoftBIS_REST_API_Sales.Models">
  <BrokerContact>sample string 14</BrokerContact>
  <BrokerEmail>sample string 15</BrokerEmail>
  <BrokerNotes>sample string 13</BrokerNotes>
  <BrokerRefNo>sample string 16</BrokerRefNo>
  <Budget>sample string 11</Budget>
  <Contact>
    <AddressLine1>sample string 9</AddressLine1>
    <AddressLine2>sample string 10</AddressLine2>
    <BusinessRole>sample string 5</BusinessRole>
    <City>sample string 11</City>
    <CompanyName>sample string 1</CompanyName>
    <Country>sample string 14</Country>
    <CountyOrState>sample string 12</CountyOrState>
    <Email>sample string 6</Email>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <Mobile>sample string 8</Mobile>
    <Phone>sample string 7</Phone>
    <PostOrZipCode>sample string 13</PostOrZipCode>
    <Title>sample string 2</Title>
  </Contact>
  <CreateATask>true</CreateATask>
  <EnquryDateTime>2026-01-08T11:19:41.6522306+00:00</EnquryDateTime>
  <ExpectedStartDate>2026-01-08T11:19:41.6522306+00:00</ExpectedStartDate>
  <LeadID>1</LeadID>
  <LeadManagerID>10</LeadManagerID>
  <LeadStatusID>9</LeadStatusID>
  <LocationSought>sample string 3</LocationSought>
  <NoOfPeople>6</NoOfPeople>
  <OfferedLocationID>4</OfferedLocationID>
  <Product>sample string 5</Product>
  <Source>sample string 12</Source>
  <Task>
    <Cancelled>true</Cancelled>
    <Completed>true</Completed>
    <Important>true</Important>
    <LeadID>2</LeadID>
    <TaskDateTime>2026-01-08T11:19:41.6678317+00:00</TaskDateTime>
    <TaskForUserID>4</TaskForUserID>
    <TaskID>1</TaskID>
    <TaskLocation>sample string 10</TaskLocation>
    <TaskNote>sample string 9</TaskNote>
    <TaskTypeID>3</TaskTypeID>
  </Task>
  <TermMonths>8</TermMonths>
</LeadNewData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

{ "LeadID": 54321, "Error": "" }

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.