Create or update lead
curl --request POST \
--url https://api.roofkit.ai/api/v1/leads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"external_id": "<string>",
"external_source": "<string>",
"session_id": "<string>",
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"property_address": "<string>",
"form_data": {},
"custom_fields": {},
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"status_stage_id": "<string>",
"attribution": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>",
"conversion_url": "<string>"
},
"marketing_attribution_overrides": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>"
},
"notes": "<string>",
"quote_value": 5000000,
"sales_value": 5000000,
"follow_up_date": "2023-11-07T05:31:56Z",
"lead_type": "<string>"
}
'import requests
url = "https://api.roofkit.ai/api/v1/leads"
payload = {
"external_id": "<string>",
"external_source": "<string>",
"session_id": "<string>",
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"property_address": "<string>",
"form_data": {},
"custom_fields": {},
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"status_stage_id": "<string>",
"attribution": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>",
"conversion_url": "<string>"
},
"marketing_attribution_overrides": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>"
},
"notes": "<string>",
"quote_value": 5000000,
"sales_value": 5000000,
"follow_up_date": "2023-11-07T05:31:56Z",
"lead_type": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
external_id: '<string>',
external_source: '<string>',
session_id: '<string>',
contact_name: '<string>',
contact_email: 'jsmith@example.com',
contact_phone: '<string>',
property_address: '<string>',
form_data: {},
custom_fields: {},
selected_material_id: '<string>',
selected_color_id: '<string>',
selected_shape_id: '<string>',
status_stage_id: '<string>',
attribution: {
source: '<string>',
medium: '<string>',
campaign: '<string>',
content: '<string>',
conversion_url: '<string>'
},
marketing_attribution_overrides: {
source: '<string>',
medium: '<string>',
campaign: '<string>',
content: '<string>'
},
notes: '<string>',
quote_value: 5000000,
sales_value: 5000000,
follow_up_date: '2023-11-07T05:31:56Z',
lead_type: '<string>'
})
};
fetch('https://api.roofkit.ai/api/v1/leads', 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://api.roofkit.ai/api/v1/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_id' => '<string>',
'external_source' => '<string>',
'session_id' => '<string>',
'contact_name' => '<string>',
'contact_email' => 'jsmith@example.com',
'contact_phone' => '<string>',
'property_address' => '<string>',
'form_data' => [
],
'custom_fields' => [
],
'selected_material_id' => '<string>',
'selected_color_id' => '<string>',
'selected_shape_id' => '<string>',
'status_stage_id' => '<string>',
'attribution' => [
'source' => '<string>',
'medium' => '<string>',
'campaign' => '<string>',
'content' => '<string>',
'conversion_url' => '<string>'
],
'marketing_attribution_overrides' => [
'source' => '<string>',
'medium' => '<string>',
'campaign' => '<string>',
'content' => '<string>'
],
'notes' => '<string>',
'quote_value' => 5000000,
'sales_value' => 5000000,
'follow_up_date' => '2023-11-07T05:31:56Z',
'lead_type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://api.roofkit.ai/api/v1/leads"
payload := strings.NewReader("{\n \"external_id\": \"<string>\",\n \"external_source\": \"<string>\",\n \"session_id\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"property_address\": \"<string>\",\n \"form_data\": {},\n \"custom_fields\": {},\n \"selected_material_id\": \"<string>\",\n \"selected_color_id\": \"<string>\",\n \"selected_shape_id\": \"<string>\",\n \"status_stage_id\": \"<string>\",\n \"attribution\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\",\n \"conversion_url\": \"<string>\"\n },\n \"marketing_attribution_overrides\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"quote_value\": 5000000,\n \"sales_value\": 5000000,\n \"follow_up_date\": \"2023-11-07T05:31:56Z\",\n \"lead_type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://api.roofkit.ai/api/v1/leads")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"<string>\",\n \"external_source\": \"<string>\",\n \"session_id\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"property_address\": \"<string>\",\n \"form_data\": {},\n \"custom_fields\": {},\n \"selected_material_id\": \"<string>\",\n \"selected_color_id\": \"<string>\",\n \"selected_shape_id\": \"<string>\",\n \"status_stage_id\": \"<string>\",\n \"attribution\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\",\n \"conversion_url\": \"<string>\"\n },\n \"marketing_attribution_overrides\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"quote_value\": 5000000,\n \"sales_value\": 5000000,\n \"follow_up_date\": \"2023-11-07T05:31:56Z\",\n \"lead_type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roofkit.ai/api/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"<string>\",\n \"external_source\": \"<string>\",\n \"session_id\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"property_address\": \"<string>\",\n \"form_data\": {},\n \"custom_fields\": {},\n \"selected_material_id\": \"<string>\",\n \"selected_color_id\": \"<string>\",\n \"selected_shape_id\": \"<string>\",\n \"status_stage_id\": \"<string>\",\n \"attribution\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\",\n \"conversion_url\": \"<string>\"\n },\n \"marketing_attribution_overrides\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"quote_value\": 5000000,\n \"sales_value\": 5000000,\n \"follow_up_date\": \"2023-11-07T05:31:56Z\",\n \"lead_type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"lead": {
"id": "<string>",
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"property_address": "<string>",
"status": "<string>",
"status_stage_id": "<string>",
"attribution": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>",
"conversion_url": "<string>",
"entry": "button"
},
"communication_summary": {
"last_call_at": "2023-11-07T05:31:56Z",
"last_sms_at": "2023-11-07T05:31:56Z",
"call_count": 123,
"answered_call_count": 123,
"missed_call_count": 123,
"sms_inbound_count": 123,
"sms_outbound_count": 123,
"last_tracking_number": {
"label": "<string>",
"phone_last4": "<string>",
"national_format": "<string>"
},
"last_communication_source": "<string>",
"last_communication_campaign": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"external_source": "<string>",
"status_label": "<string>",
"status_sort_order": 123,
"is_conversion_stage": true,
"stage_timestamps": {},
"funnel_gap_summary": {},
"lead_type": "<string>",
"lead_type_label": "<string>",
"landing_url": "<string>",
"first_form_name": "<string>",
"form_data": {},
"custom_fields": {},
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"notes": "<string>",
"quote_value": 123,
"sales_value": 123,
"follow_up_date": "2023-11-07T05:31:56Z",
"converted_at": "2023-11-07T05:31:56Z"
},
"created": true
}{
"lead": {
"id": "<string>",
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"property_address": "<string>",
"status": "<string>",
"status_stage_id": "<string>",
"attribution": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>",
"conversion_url": "<string>",
"entry": "button"
},
"communication_summary": {
"last_call_at": "2023-11-07T05:31:56Z",
"last_sms_at": "2023-11-07T05:31:56Z",
"call_count": 123,
"answered_call_count": 123,
"missed_call_count": 123,
"sms_inbound_count": 123,
"sms_outbound_count": 123,
"last_tracking_number": {
"label": "<string>",
"phone_last4": "<string>",
"national_format": "<string>"
},
"last_communication_source": "<string>",
"last_communication_campaign": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"external_source": "<string>",
"status_label": "<string>",
"status_sort_order": 123,
"is_conversion_stage": true,
"stage_timestamps": {},
"funnel_gap_summary": {},
"lead_type": "<string>",
"lead_type_label": "<string>",
"landing_url": "<string>",
"first_form_name": "<string>",
"form_data": {},
"custom_fields": {},
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"notes": "<string>",
"quote_value": 123,
"sales_value": 123,
"follow_up_date": "2023-11-07T05:31:56Z",
"converted_at": "2023-11-07T05:31:56Z"
},
"created": true
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "FORBIDDEN",
"message": "API key does not include the required scope: leads.write.",
"request_id": "req_123",
"details": {
"required_scope": "leads.write",
"missing_scopes": [
"leads.write"
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Leads
Create or update lead
Creates a lead or updates the matching active lead. external_id plus external_source wins when provided; otherwise normalized phone dedupe is used as fallback.
POST
/
api
/
v1
/
leads
Create or update lead
curl --request POST \
--url https://api.roofkit.ai/api/v1/leads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"external_id": "<string>",
"external_source": "<string>",
"session_id": "<string>",
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"property_address": "<string>",
"form_data": {},
"custom_fields": {},
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"status_stage_id": "<string>",
"attribution": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>",
"conversion_url": "<string>"
},
"marketing_attribution_overrides": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>"
},
"notes": "<string>",
"quote_value": 5000000,
"sales_value": 5000000,
"follow_up_date": "2023-11-07T05:31:56Z",
"lead_type": "<string>"
}
'import requests
url = "https://api.roofkit.ai/api/v1/leads"
payload = {
"external_id": "<string>",
"external_source": "<string>",
"session_id": "<string>",
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"property_address": "<string>",
"form_data": {},
"custom_fields": {},
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"status_stage_id": "<string>",
"attribution": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>",
"conversion_url": "<string>"
},
"marketing_attribution_overrides": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>"
},
"notes": "<string>",
"quote_value": 5000000,
"sales_value": 5000000,
"follow_up_date": "2023-11-07T05:31:56Z",
"lead_type": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
external_id: '<string>',
external_source: '<string>',
session_id: '<string>',
contact_name: '<string>',
contact_email: 'jsmith@example.com',
contact_phone: '<string>',
property_address: '<string>',
form_data: {},
custom_fields: {},
selected_material_id: '<string>',
selected_color_id: '<string>',
selected_shape_id: '<string>',
status_stage_id: '<string>',
attribution: {
source: '<string>',
medium: '<string>',
campaign: '<string>',
content: '<string>',
conversion_url: '<string>'
},
marketing_attribution_overrides: {
source: '<string>',
medium: '<string>',
campaign: '<string>',
content: '<string>'
},
notes: '<string>',
quote_value: 5000000,
sales_value: 5000000,
follow_up_date: '2023-11-07T05:31:56Z',
lead_type: '<string>'
})
};
fetch('https://api.roofkit.ai/api/v1/leads', 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://api.roofkit.ai/api/v1/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_id' => '<string>',
'external_source' => '<string>',
'session_id' => '<string>',
'contact_name' => '<string>',
'contact_email' => 'jsmith@example.com',
'contact_phone' => '<string>',
'property_address' => '<string>',
'form_data' => [
],
'custom_fields' => [
],
'selected_material_id' => '<string>',
'selected_color_id' => '<string>',
'selected_shape_id' => '<string>',
'status_stage_id' => '<string>',
'attribution' => [
'source' => '<string>',
'medium' => '<string>',
'campaign' => '<string>',
'content' => '<string>',
'conversion_url' => '<string>'
],
'marketing_attribution_overrides' => [
'source' => '<string>',
'medium' => '<string>',
'campaign' => '<string>',
'content' => '<string>'
],
'notes' => '<string>',
'quote_value' => 5000000,
'sales_value' => 5000000,
'follow_up_date' => '2023-11-07T05:31:56Z',
'lead_type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://api.roofkit.ai/api/v1/leads"
payload := strings.NewReader("{\n \"external_id\": \"<string>\",\n \"external_source\": \"<string>\",\n \"session_id\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"property_address\": \"<string>\",\n \"form_data\": {},\n \"custom_fields\": {},\n \"selected_material_id\": \"<string>\",\n \"selected_color_id\": \"<string>\",\n \"selected_shape_id\": \"<string>\",\n \"status_stage_id\": \"<string>\",\n \"attribution\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\",\n \"conversion_url\": \"<string>\"\n },\n \"marketing_attribution_overrides\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"quote_value\": 5000000,\n \"sales_value\": 5000000,\n \"follow_up_date\": \"2023-11-07T05:31:56Z\",\n \"lead_type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://api.roofkit.ai/api/v1/leads")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"<string>\",\n \"external_source\": \"<string>\",\n \"session_id\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"property_address\": \"<string>\",\n \"form_data\": {},\n \"custom_fields\": {},\n \"selected_material_id\": \"<string>\",\n \"selected_color_id\": \"<string>\",\n \"selected_shape_id\": \"<string>\",\n \"status_stage_id\": \"<string>\",\n \"attribution\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\",\n \"conversion_url\": \"<string>\"\n },\n \"marketing_attribution_overrides\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"quote_value\": 5000000,\n \"sales_value\": 5000000,\n \"follow_up_date\": \"2023-11-07T05:31:56Z\",\n \"lead_type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roofkit.ai/api/v1/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"<string>\",\n \"external_source\": \"<string>\",\n \"session_id\": \"<string>\",\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"property_address\": \"<string>\",\n \"form_data\": {},\n \"custom_fields\": {},\n \"selected_material_id\": \"<string>\",\n \"selected_color_id\": \"<string>\",\n \"selected_shape_id\": \"<string>\",\n \"status_stage_id\": \"<string>\",\n \"attribution\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\",\n \"conversion_url\": \"<string>\"\n },\n \"marketing_attribution_overrides\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"content\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"quote_value\": 5000000,\n \"sales_value\": 5000000,\n \"follow_up_date\": \"2023-11-07T05:31:56Z\",\n \"lead_type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"lead": {
"id": "<string>",
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"property_address": "<string>",
"status": "<string>",
"status_stage_id": "<string>",
"attribution": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>",
"conversion_url": "<string>",
"entry": "button"
},
"communication_summary": {
"last_call_at": "2023-11-07T05:31:56Z",
"last_sms_at": "2023-11-07T05:31:56Z",
"call_count": 123,
"answered_call_count": 123,
"missed_call_count": 123,
"sms_inbound_count": 123,
"sms_outbound_count": 123,
"last_tracking_number": {
"label": "<string>",
"phone_last4": "<string>",
"national_format": "<string>"
},
"last_communication_source": "<string>",
"last_communication_campaign": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"external_source": "<string>",
"status_label": "<string>",
"status_sort_order": 123,
"is_conversion_stage": true,
"stage_timestamps": {},
"funnel_gap_summary": {},
"lead_type": "<string>",
"lead_type_label": "<string>",
"landing_url": "<string>",
"first_form_name": "<string>",
"form_data": {},
"custom_fields": {},
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"notes": "<string>",
"quote_value": 123,
"sales_value": 123,
"follow_up_date": "2023-11-07T05:31:56Z",
"converted_at": "2023-11-07T05:31:56Z"
},
"created": true
}{
"lead": {
"id": "<string>",
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"property_address": "<string>",
"status": "<string>",
"status_stage_id": "<string>",
"attribution": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"content": "<string>",
"conversion_url": "<string>",
"entry": "button"
},
"communication_summary": {
"last_call_at": "2023-11-07T05:31:56Z",
"last_sms_at": "2023-11-07T05:31:56Z",
"call_count": 123,
"answered_call_count": 123,
"missed_call_count": 123,
"sms_inbound_count": 123,
"sms_outbound_count": 123,
"last_tracking_number": {
"label": "<string>",
"phone_last4": "<string>",
"national_format": "<string>"
},
"last_communication_source": "<string>",
"last_communication_campaign": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"external_source": "<string>",
"status_label": "<string>",
"status_sort_order": 123,
"is_conversion_stage": true,
"stage_timestamps": {},
"funnel_gap_summary": {},
"lead_type": "<string>",
"lead_type_label": "<string>",
"landing_url": "<string>",
"first_form_name": "<string>",
"form_data": {},
"custom_fields": {},
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"notes": "<string>",
"quote_value": 123,
"sales_value": 123,
"follow_up_date": "2023-11-07T05:31:56Z",
"converted_at": "2023-11-07T05:31:56Z"
},
"created": true
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "FORBIDDEN",
"message": "API key does not include the required scope: leads.write.",
"request_id": "req_123",
"details": {
"required_scope": "leads.write",
"missing_scopes": [
"leads.write"
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Required scopes:
leads.writeAuthorizations
Use Authorization: Bearer rk_live_....
Headers
A unique value for each new request, such as a UUID. Send the same value to retry a request safely. The same key and payload replay the first response with Idempotency-Replayed: true.
Required string length:
1 - 160Body
application/json
Maximum string length:
200Maximum string length:
120Maximum string length:
500Maximum string length:
200US-only phone. Invalid or non-US values return VALIDATION_ERROR.
Optional property address. Empty, explicit US country, or US state + ZIP formats are accepted; clearly non-US values return VALIDATION_ERROR.
Maximum string length:
500Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
5000Number or numeric string accepted on write. Serialized responses use number or null.
Required range:
0 <= x <= 10000000Number or numeric string accepted on write. Serialized responses use number or null.
Required range:
0 <= x <= 10000000ISO 8601 date-time with Z or a ±HH:MM offset. Stored as UTC.
Key or current label of a workspace lead type. RoofKit stores the key. When omitted, a new Contact gets external. When omitted on an upsert that matches an existing Contact, an empty lead type becomes external and a set lead type stays. A sent value always replaces the current one. An unknown value returns VALIDATION_ERROR.
Required string length:
1 - 100