FieldEdge Open API
DocsAPIs
DocsAPIs
  1. Lead
  • Lead
    • Creates a new lead with customer details, appointment preferences, and service information.
      POST
    • Fetches lead details based on the provided lead identifier.
      GET
  • Customer
    • Creates a new customer
      POST
    • Search customers by phone, email, or first name
      GET
    • Search customers based on address details.
      GET
    • Get customer details by ID
      GET
    • Updates an existing customer
      PUT
  • Webhook
    • Registers a new webhook endpoint to receive event notifications.
      POST
DocsAPIs
DocsAPIs
  1. Lead

Creates a new lead with customer details, appointment preferences, and service information.

POST
/v1/leads
Creates a new lead record in the system.

Request

Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Lead created successfully
Body

🟠400
🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://dev.api.fieldedge.com/leads/v1/leads' \
--header 'Content-Type: application/json' \
--data-raw '{
    "trackingId": null,
    "source": "trane",
    "preferredContactMethod": "phone",
    "isExistingCustomer": false,
    "customer": {
        "customerRefId": "db6d3e68-66c1-4504-b9e5-eb9bd1cb4e2b",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@email.com",
        "phone": "1234567890",
        "marketingEmailOptedIn": true,
        "address": {
            "addressRefId": "3f54d8f3-8a73-47c2-b5ce-0e8a79e39311",
            "addressLine1": "123 Main Street",
            "addressLine2": "Unit 5",
            "city": "Miami",
            "state": "FL",
            "postalCode": "33101",
            "country": "USA"
        }
    },
    "appointment": {
        "preferredDate": "2025-07-24",
        "preferredTime": "16:24",
        "timezone": "America/New_York",
        "availabilityNotes": "Available anytime after 4 PM",
        "location": {
            "addressRefId": "c1e2d5b0-873b-4f33-9f4c-9b06fb2cd401",
            "addressLine1": "456 Service Ave",
            "addressLine2": "Suite 12",
            "city": "Orlando",
            "state": "FL",
            "postalCode": "32801",
            "country": "USA"
        }
    },
    "serviceRequest": {
        "serviceCategory": "HVAC",
        "serviceType": "AC Repair",
        "issueDescription": "Air conditioner is not cooling",
        "image": "base64-image-content",
        "urgency": "High"
    },
    "metaData": {
        "campaign": "SummerPromo2025",
        "refSource": "MobileApp"
    }
}'
Response Response Example
201 - response
{
    "data": {
        "leadId": "c1e2d5b0-873b-4f33-9f4c-9b06fb2cd401",
        "status": "Initiated",
        "receivedAt": "2025-02-14T10:35:21Z"
    }
}
Modified at 2026-02-26 12:18:17
Next
Fetches lead details based on the provided lead identifier.
Built with