Skip to main content
PUT
/
general-leads
/
{id}
/
status
Update job status
curl --request PUT \
  --url https://www.renovationfind.com/rest-api-v1/general-leads/{id}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "HOMEOWNER_CONTACTED"
}
'
{
  "success": true,
  "data": {
    "id": 123,
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "actionDate": "2023-11-07T05:31:56Z",
    "category": "<string>",
    "customerName": "<string>",
    "customerEmail": "jsmith@example.com",
    "customerPhone": "<string>",
    "customerAddress": "<string>",
    "projectDetailsHtml": "<string>",
    "originalJobDescription": "<string>",
    "vendorNotificationViewed": true,
    "vendorLeadAction": "NONE",
    "declineReason": "<string>",
    "postLeadStatus": "NO_RESPONSE",
    "postLeadRequiresAction": true,
    "customerInformationHtml": "<string>",
    "postLeadStatusData": {
      "status": "NO_RESPONSE",
      "statusActionDate": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "meetupScheduledDate": "2023-11-07T05:31:56Z",
      "jobAmount": 123,
      "requiresAction": true,
      "contactMethod": "PHONE_CALL",
      "estimateType": "IN_PERSON_ESTIMATE",
      "lostReason": "PRICE",
      "estimatedProjectStartDate": "2023-11-07T05:31:56Z",
      "estimatedCompletionDate": "2023-11-07T05:31:56Z",
      "startDateTbd": true,
      "completionDateTbd": true
    },
    "attachments": [
      {
        "id": 123,
        "displayFilename": "<string>",
        "contentType": "<string>",
        "uploadDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

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

Path Parameters

​
id
integer<int64>
required

Body

application/json
​
status
enum<string>
required

New job status. Required fields vary by status:

  • MEETUP_SCHEDULED: requires meetingScheduledDate
  • JOB_WON: requires jobAmount (immutable once set)
  • JOB_LOST, JOB_POSTPONED_OR_CANCELLED, OTHER: requires reason
  • LEAD_WON: requires jobAmount, (estimatedProjectStartDate or startDateTbd), (estimatedCompletionDate or completionDateTbd). Immutable once set. Attachment soft-required.
  • LEAD_LOST: requires lostReason. reason required when lostReason is OTHER.
  • REACHED_OUT_TO_HOMEOWNER, MULTIPLE_ATTEMPTS_NO_RESPONSE, CONTACT_MADE, ESTIMATE_PROVIDED: no required fields
Available options:
HOMEOWNER_CONTACTED,
MEETUP_SCHEDULED,
QUOTE_SENT,
JOB_PENDING_DECISION,
JOB_WON,
JOB_LOST,
JOB_POSTPONED_OR_CANCELLED,
NO_RESPONSE_FROM_HOMEOWNER,
OTHER,
REACHED_OUT_TO_HOMEOWNER,
MULTIPLE_ATTEMPTS_NO_RESPONSE,
CONTACT_MADE,
ESTIMATE_PROVIDED,
LEAD_WON,
LEAD_LOST
​
reason
string

Notes/reason text. Required for JOB_LOST, JOB_POSTPONED_OR_CANCELLED, OTHER. Required for LEAD_LOST when lostReason is OTHER. Optional for all other statuses.

Maximum string length: 500
​
meetingScheduledDate
string<date>

Required for MEETUP_SCHEDULED

​
jobAmount
number<double>

Required for JOB_WON and LEAD_WON

​
contactMethod
enum<string>

Optional for REACHED_OUT_TO_HOMEOWNER and CONTACT_MADE

Available options:
PHONE_CALL,
TEXT,
EMAIL,
IN_PERSON_MEETING
​
estimateType
enum<string>

Optional for ESTIMATE_PROVIDED

Available options:
IN_PERSON_ESTIMATE,
EMAILED_ESTIMATE,
VERBAL_ESTIMATE,
PORTAL_ATTACHMENT_ESTIMATE,
OTHER
​
lostReason
enum<string>

Required for LEAD_LOST

Available options:
PRICE,
TIMING,
OTHER
​
estimatedProjectStartDate
string<date>

Required for LEAD_WON (unless startDateTbd is true)

​
estimatedCompletionDate
string<date>

Required for LEAD_WON (unless completionDateTbd is true)

​
startDateTbd
boolean

Set to true if project start date is TBD (LEAD_WON)

​
completionDateTbd
boolean

Set to true if completion date is TBD (LEAD_WON)

Response

Status updated, returns updated lead details

​
success
boolean
Example:

true

​
data
object

Full detail view of a vendor-assigned lead. Includes all fields from the lite view plus post-lead status data and file attachments.