Skip to main content
POST
/
general-leads
Create a general lead
curl --request POST \
  --url https://www.renovationfind.com/rest-manager-api-v1/general-leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "jobAmount": 123,
  "postalCode": "<string>",
  "jobDescription": "<string>",
  "referrerVendorId": 123,
  "notifyCustomer": true,
  "createLeadInPipedrive": true
}
'
{
  "success": true,
  "data": {
    "id": 123,
    "customerName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "jobDescription": "<string>",
    "jobAmount": 123,
    "paidAmount": 123,
    "detailedProjectDescription": "<string>",
    "generalLeadStatus": "<string>",
    "specificLeadStatus": "<string>",
    "leadSourceType": "<string>",
    "assignedVendorId": 123,
    "assignedVendorName": "<string>",
    "referrerVendorId": 123,
    "referrerVendorName": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "serviceBoundary": {
      "id": 123,
      "name": "<string>",
      "urlPath": "<string>",
      "cityName": "<string>"
    },
    "contactTime": "<string>",
    "contactMethod": "<string>",
    "leadTimeframe": "<string>",
    "quoteTimeframe": "<string>",
    "projectStage": "<string>",
    "renofindLeadType": "<string>",
    "jobBudget": 123,
    "paymentStatus": "<string>",
    "phoneLead": true,
    "externalNotes": "<string>",
    "essentialInternalNotes": "<string>",
    "requiresAction": true,
    "requireActionReason": "<string>",
    "endCustomer": {
      "id": 123,
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>"
    }
  },
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.renovationfind.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

JWT token issued from the RenovationFind Manager Portal

Body

application/json

Form for creating a new general lead. At least one of email or phone is required.

customerName
string
Maximum string length: 200
email
string
Maximum string length: 200
phone
string
Maximum string length: 30
jobAmount
number<double>
Required range: x <= 100000000
postalCode
string
Maximum string length: 10
jobDescription
string
Maximum string length: 5000
referrerVendorId
integer<int64>
notifyCustomer
boolean
createLeadInPipedrive
boolean

Response

Lead created

success
boolean
data
object

Full general lead representation with all details including customer info, job details, vendor relations, location, financial info, and communications.

message
string