Skip to main content
Leads represent potential customers or business opportunities. Use this endpoint to submit leads directly into the FieldIU sales pipeline.

​
Create Lead

Creates a new lead record in FieldIU.

​
Request Body

​
firstName
string
Lead’s first name
​
lastName
string
Lead’s last name
​
title
string
Lead’s job title
​
companyName
string
Company or organization name
​
email
string
Lead’s email address
​
mobilePhone
string
Lead’s mobile phone number
​
businessPhone
string
Lead’s business phone number
​
leadSource
integer
Source of the lead. See NullableOflead_leadsourcecode for valid values
​
accountType
integer
Account type. See NullableOflead_ha_accounttype for valid values
​
rating
integer
Lead quality rating. See NullableOflead_leadqualitycode for valid values
​
estimatedValue
number
Estimated deal value (double precision float)
​
estimatedCloseDate
string
Estimated close date in ISO 8601 format (e.g. 2024-09-30T00:00:00Z)
​
buildingLocation
string
Building or location name
​
street1
string
Street address line 1
​
street2
string
Street address line 2
​
city
string
City
​
postalCode
string
Postal / ZIP code
​
state
string
State or province
​
country
string
Country

​
Example Request

curl -X POST https://integration.fieldiu.online/api/v1/leads \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your_api_key" \
  -H "X-ORG-ID: your_org_id" \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "title": "Facilities Manager",
    "companyName": "Acme Corporation",
    "email": "john.doe@acme.com",
    "mobilePhone": "+1-555-000-9999",
    "leadSource": 2,
    "estimatedValue": 15000.00,
    "estimatedCloseDate": "2024-09-30T00:00:00Z",
    "city": "Dubai",
    "country": "UAE"
  }'

const response = await fetch('https://integration.fieldiu.online/api/v1/leads', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-KEY': 'your_api_key',
    'X-ORG-ID': 'your_org_id'
  },
  body: JSON.stringify({
    firstName: 'John',
    lastName: 'Doe',
    title: 'Facilities Manager',
    companyName: 'Acme Corporation',
    email: 'john.doe@acme.com',
    mobilePhone: '+1-555-000-9999',
    leadSource: 2,
    estimatedValue: 15000.00,
    estimatedCloseDate: '2024-09-30T00:00:00Z',
    city: 'Dubai',
    country: 'UAE'
  })
});

​
Response

200 OK — Lead created successfully.