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"
}
'
import requests

url = "https://www.renovationfind.com/rest-api-v1/general-leads/{id}/status"

payload = { "status": "HOMEOWNER_CONTACTED" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'HOMEOWNER_CONTACTED'})
};

fetch('https://www.renovationfind.com/rest-api-v1/general-leads/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.renovationfind.com/rest-api-v1/general-leads/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'HOMEOWNER_CONTACTED'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://www.renovationfind.com/rest-api-v1/general-leads/{id}/status"

payload := strings.NewReader("{\n \"status\": \"HOMEOWNER_CONTACTED\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://www.renovationfind.com/rest-api-v1/general-leads/{id}/status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"HOMEOWNER_CONTACTED\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://www.renovationfind.com/rest-api-v1/general-leads/{id}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"HOMEOWNER_CONTACTED\"\n}"

response = http.request(request)
puts response.read_body
{
  "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,
    "declineReason": "<string>",
    "postLeadRequiresAction": true,
    "customerInformationHtml": "<string>",
    "postLeadStatusData": {
      "statusActionDate": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "meetupScheduledDate": "2023-11-07T05:31:56Z",
      "jobAmount": 123,
      "requiresAction": true,
      "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"
      }
    ]
  }
}
{
"success": false,
"error": "<string>"
}
{
"success": false,
"error": "<string>"
}
{
"success": false,
"error": "Rate limit exceeded. Maximum 250 requests per 5 minutes. Please retry later."
}

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.