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
    },
    "attachments": [
      {
        "id": 123,
        "displayFilename": "<string>",
        "contentType": "<string>",
        "uploadDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

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
Available options:
HOMEOWNER_CONTACTED,
MEETUP_SCHEDULED,
QUOTE_SENT,
JOB_PENDING_DECISION,
JOB_WON,
JOB_LOST,
JOB_POSTPONED_OR_CANCELLED,
NO_RESPONSE_FROM_HOMEOWNER,
OTHER
​
reason
string

Required for JOB_LOST, JOB_POSTPONED_OR_CANCELLED, OTHER

Maximum string length: 500
​
meetingScheduledDate
string<date>

Required for MEETUP_SCHEDULED

​
jobAmount
number<double>

Required for JOB_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.