Skip to main content
PUT
/
general-leads
/
{generalLeadId}
Update a general lead
curl --request PUT \
  --url https://www.renovationfind.com/rest-manager-api-v1/general-leads/{generalLeadId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --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>"
  }
}
'
import requests

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

payload = {
"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>"
}
}
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({
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>'}
})
};

fetch('https://www.renovationfind.com/rest-manager-api-v1/general-leads/{generalLeadId}', 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-manager-api-v1/general-leads/{generalLeadId}",
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([
'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>'
]
]),
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-manager-api-v1/general-leads/{generalLeadId}"

payload := strings.NewReader("{\n \"id\": 123,\n \"customerName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateCreated\": \"2023-11-07T05:31:56Z\",\n \"dateModified\": \"2023-11-07T05:31:56Z\",\n \"jobDescription\": \"<string>\",\n \"jobAmount\": 123,\n \"paidAmount\": 123,\n \"detailedProjectDescription\": \"<string>\",\n \"generalLeadStatus\": \"<string>\",\n \"specificLeadStatus\": \"<string>\",\n \"leadSourceType\": \"<string>\",\n \"assignedVendorId\": 123,\n \"assignedVendorName\": \"<string>\",\n \"referrerVendorId\": 123,\n \"referrerVendorName\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"serviceBoundary\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"urlPath\": \"<string>\",\n \"cityName\": \"<string>\"\n },\n \"contactTime\": \"<string>\",\n \"contactMethod\": \"<string>\",\n \"leadTimeframe\": \"<string>\",\n \"quoteTimeframe\": \"<string>\",\n \"projectStage\": \"<string>\",\n \"renofindLeadType\": \"<string>\",\n \"jobBudget\": 123,\n \"paymentStatus\": \"<string>\",\n \"phoneLead\": true,\n \"externalNotes\": \"<string>\",\n \"essentialInternalNotes\": \"<string>\",\n \"requiresAction\": true,\n \"requireActionReason\": \"<string>\",\n \"endCustomer\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\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-manager-api-v1/general-leads/{generalLeadId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 123,\n \"customerName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateCreated\": \"2023-11-07T05:31:56Z\",\n \"dateModified\": \"2023-11-07T05:31:56Z\",\n \"jobDescription\": \"<string>\",\n \"jobAmount\": 123,\n \"paidAmount\": 123,\n \"detailedProjectDescription\": \"<string>\",\n \"generalLeadStatus\": \"<string>\",\n \"specificLeadStatus\": \"<string>\",\n \"leadSourceType\": \"<string>\",\n \"assignedVendorId\": 123,\n \"assignedVendorName\": \"<string>\",\n \"referrerVendorId\": 123,\n \"referrerVendorName\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"serviceBoundary\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"urlPath\": \"<string>\",\n \"cityName\": \"<string>\"\n },\n \"contactTime\": \"<string>\",\n \"contactMethod\": \"<string>\",\n \"leadTimeframe\": \"<string>\",\n \"quoteTimeframe\": \"<string>\",\n \"projectStage\": \"<string>\",\n \"renofindLeadType\": \"<string>\",\n \"jobBudget\": 123,\n \"paymentStatus\": \"<string>\",\n \"phoneLead\": true,\n \"externalNotes\": \"<string>\",\n \"essentialInternalNotes\": \"<string>\",\n \"requiresAction\": true,\n \"requireActionReason\": \"<string>\",\n \"endCustomer\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"id\": 123,\n \"customerName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateCreated\": \"2023-11-07T05:31:56Z\",\n \"dateModified\": \"2023-11-07T05:31:56Z\",\n \"jobDescription\": \"<string>\",\n \"jobAmount\": 123,\n \"paidAmount\": 123,\n \"detailedProjectDescription\": \"<string>\",\n \"generalLeadStatus\": \"<string>\",\n \"specificLeadStatus\": \"<string>\",\n \"leadSourceType\": \"<string>\",\n \"assignedVendorId\": 123,\n \"assignedVendorName\": \"<string>\",\n \"referrerVendorId\": 123,\n \"referrerVendorName\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"serviceBoundary\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"urlPath\": \"<string>\",\n \"cityName\": \"<string>\"\n },\n \"contactTime\": \"<string>\",\n \"contactMethod\": \"<string>\",\n \"leadTimeframe\": \"<string>\",\n \"quoteTimeframe\": \"<string>\",\n \"projectStage\": \"<string>\",\n \"renofindLeadType\": \"<string>\",\n \"jobBudget\": 123,\n \"paymentStatus\": \"<string>\",\n \"phoneLead\": true,\n \"externalNotes\": \"<string>\",\n \"essentialInternalNotes\": \"<string>\",\n \"requiresAction\": true,\n \"requireActionReason\": \"<string>\",\n \"endCustomer\": {\n \"id\": 123,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
}

Authorizations

Authorization
string
header
required

JWT token issued from the RenovationFind Manager Portal

Path Parameters

generalLeadId
integer<int64>
required

Body

application/json

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

id
integer<int64>
customerName
string
email
string
phone
string
dateCreated
string<date-time>
dateModified
string<date-time>
jobDescription
string
jobAmount
number<double>
paidAmount
number<double>
detailedProjectDescription
string
generalLeadStatus
string
specificLeadStatus
string
leadSourceType
string
assignedVendorId
integer<int64>
assignedVendorName
string
referrerVendorId
integer<int64>
referrerVendorName
string
postalCode
string
city
string
serviceBoundary
object
contactTime
string
contactMethod
string
leadTimeframe
string
quoteTimeframe
string
projectStage
string
renofindLeadType
string
jobBudget
number<double>
paymentStatus
string
phoneLead
boolean
externalNotes
string
essentialInternalNotes
string
requiresAction
boolean
requireActionReason
string
endCustomer
object

Response

200 - application/json

Lead updated

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