curl --request PATCH \
--url https://api.getnexor.ai/api/public/leads/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"first_name": "Carlos",
"last_name": "Rodriguez",
"email": "carlos@example.com",
"phone": "+56987654321",
"company": "Stark Industries",
"title": "Manager",
"source": "website",
"campaign_id": "123e4567-e89b-12d3-a456-426614174001",
"metadata": {
"estado_lead": "calificado",
"broker_asociado": "Maria Gonzalez"
},
"assigned_to": "123e4567-e89b-12d3-a456-426614174002",
"do_not_contact": true,
"is_unsubscribed": true
}
'import requests
url = "https://api.getnexor.ai/api/public/leads/{id}"
payload = {
"first_name": "Carlos",
"last_name": "Rodriguez",
"email": "carlos@example.com",
"phone": "+56987654321",
"company": "Stark Industries",
"title": "Manager",
"source": "website",
"campaign_id": "123e4567-e89b-12d3-a456-426614174001",
"metadata": {
"estado_lead": "calificado",
"broker_asociado": "Maria Gonzalez"
},
"assigned_to": "123e4567-e89b-12d3-a456-426614174002",
"do_not_contact": True,
"is_unsubscribed": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: 'Carlos',
last_name: 'Rodriguez',
email: 'carlos@example.com',
phone: '+56987654321',
company: 'Stark Industries',
title: 'Manager',
source: 'website',
campaign_id: '123e4567-e89b-12d3-a456-426614174001',
metadata: {estado_lead: 'calificado', broker_asociado: 'Maria Gonzalez'},
assigned_to: '123e4567-e89b-12d3-a456-426614174002',
do_not_contact: true,
is_unsubscribed: true
})
};
fetch('https://api.getnexor.ai/api/public/leads/{id}', 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.getnexor.ai/api/public/leads/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => 'Carlos',
'last_name' => 'Rodriguez',
'email' => 'carlos@example.com',
'phone' => '+56987654321',
'company' => 'Stark Industries',
'title' => 'Manager',
'source' => 'website',
'campaign_id' => '123e4567-e89b-12d3-a456-426614174001',
'metadata' => [
'estado_lead' => 'calificado',
'broker_asociado' => 'Maria Gonzalez'
],
'assigned_to' => '123e4567-e89b-12d3-a456-426614174002',
'do_not_contact' => true,
'is_unsubscribed' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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.getnexor.ai/api/public/leads/{id}"
payload := strings.NewReader("{\n \"first_name\": \"Carlos\",\n \"last_name\": \"Rodriguez\",\n \"email\": \"carlos@example.com\",\n \"phone\": \"+56987654321\",\n \"company\": \"Stark Industries\",\n \"title\": \"Manager\",\n \"source\": \"website\",\n \"campaign_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"metadata\": {\n \"estado_lead\": \"calificado\",\n \"broker_asociado\": \"Maria Gonzalez\"\n },\n \"assigned_to\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"do_not_contact\": true,\n \"is_unsubscribed\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.patch("https://api.getnexor.ai/api/public/leads/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"Carlos\",\n \"last_name\": \"Rodriguez\",\n \"email\": \"carlos@example.com\",\n \"phone\": \"+56987654321\",\n \"company\": \"Stark Industries\",\n \"title\": \"Manager\",\n \"source\": \"website\",\n \"campaign_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"metadata\": {\n \"estado_lead\": \"calificado\",\n \"broker_asociado\": \"Maria Gonzalez\"\n },\n \"assigned_to\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"do_not_contact\": true,\n \"is_unsubscribed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/leads/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"Carlos\",\n \"last_name\": \"Rodriguez\",\n \"email\": \"carlos@example.com\",\n \"phone\": \"+56987654321\",\n \"company\": \"Stark Industries\",\n \"title\": \"Manager\",\n \"source\": \"website\",\n \"campaign_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"metadata\": {\n \"estado_lead\": \"calificado\",\n \"broker_asociado\": \"Maria Gonzalez\"\n },\n \"assigned_to\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"do_not_contact\": true,\n \"is_unsubscribed\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"lead": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"source": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"last_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"company": "<string>",
"title": "<string>",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Patch Lead
Partial update of a lead.
curl --request PATCH \
--url https://api.getnexor.ai/api/public/leads/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"first_name": "Carlos",
"last_name": "Rodriguez",
"email": "carlos@example.com",
"phone": "+56987654321",
"company": "Stark Industries",
"title": "Manager",
"source": "website",
"campaign_id": "123e4567-e89b-12d3-a456-426614174001",
"metadata": {
"estado_lead": "calificado",
"broker_asociado": "Maria Gonzalez"
},
"assigned_to": "123e4567-e89b-12d3-a456-426614174002",
"do_not_contact": true,
"is_unsubscribed": true
}
'import requests
url = "https://api.getnexor.ai/api/public/leads/{id}"
payload = {
"first_name": "Carlos",
"last_name": "Rodriguez",
"email": "carlos@example.com",
"phone": "+56987654321",
"company": "Stark Industries",
"title": "Manager",
"source": "website",
"campaign_id": "123e4567-e89b-12d3-a456-426614174001",
"metadata": {
"estado_lead": "calificado",
"broker_asociado": "Maria Gonzalez"
},
"assigned_to": "123e4567-e89b-12d3-a456-426614174002",
"do_not_contact": True,
"is_unsubscribed": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: 'Carlos',
last_name: 'Rodriguez',
email: 'carlos@example.com',
phone: '+56987654321',
company: 'Stark Industries',
title: 'Manager',
source: 'website',
campaign_id: '123e4567-e89b-12d3-a456-426614174001',
metadata: {estado_lead: 'calificado', broker_asociado: 'Maria Gonzalez'},
assigned_to: '123e4567-e89b-12d3-a456-426614174002',
do_not_contact: true,
is_unsubscribed: true
})
};
fetch('https://api.getnexor.ai/api/public/leads/{id}', 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.getnexor.ai/api/public/leads/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => 'Carlos',
'last_name' => 'Rodriguez',
'email' => 'carlos@example.com',
'phone' => '+56987654321',
'company' => 'Stark Industries',
'title' => 'Manager',
'source' => 'website',
'campaign_id' => '123e4567-e89b-12d3-a456-426614174001',
'metadata' => [
'estado_lead' => 'calificado',
'broker_asociado' => 'Maria Gonzalez'
],
'assigned_to' => '123e4567-e89b-12d3-a456-426614174002',
'do_not_contact' => true,
'is_unsubscribed' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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.getnexor.ai/api/public/leads/{id}"
payload := strings.NewReader("{\n \"first_name\": \"Carlos\",\n \"last_name\": \"Rodriguez\",\n \"email\": \"carlos@example.com\",\n \"phone\": \"+56987654321\",\n \"company\": \"Stark Industries\",\n \"title\": \"Manager\",\n \"source\": \"website\",\n \"campaign_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"metadata\": {\n \"estado_lead\": \"calificado\",\n \"broker_asociado\": \"Maria Gonzalez\"\n },\n \"assigned_to\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"do_not_contact\": true,\n \"is_unsubscribed\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.patch("https://api.getnexor.ai/api/public/leads/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"Carlos\",\n \"last_name\": \"Rodriguez\",\n \"email\": \"carlos@example.com\",\n \"phone\": \"+56987654321\",\n \"company\": \"Stark Industries\",\n \"title\": \"Manager\",\n \"source\": \"website\",\n \"campaign_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"metadata\": {\n \"estado_lead\": \"calificado\",\n \"broker_asociado\": \"Maria Gonzalez\"\n },\n \"assigned_to\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"do_not_contact\": true,\n \"is_unsubscribed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/leads/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"Carlos\",\n \"last_name\": \"Rodriguez\",\n \"email\": \"carlos@example.com\",\n \"phone\": \"+56987654321\",\n \"company\": \"Stark Industries\",\n \"title\": \"Manager\",\n \"source\": \"website\",\n \"campaign_id\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"metadata\": {\n \"estado_lead\": \"calificado\",\n \"broker_asociado\": \"Maria Gonzalez\"\n },\n \"assigned_to\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"do_not_contact\": true,\n \"is_unsubscribed\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"lead": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"source": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"last_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"company": "<string>",
"title": "<string>",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{ "assigned_to": "123e4567-e89b-12d3-a456-426614174002" }
id). It must be an active member of your account — otherwise the request is rejected with 400. Send null to leave the lead unassigned.Authorizations
API key for authentication. Keys are prefixed with nxr_live_.
Path Parameters
Lead ID
Body
- Option 1
- Option 2
Any lead field can be updated. Metadata is shallow-merged with existing values (other keys preserved). All other fields are replaced directly.
Lead's first name
"Carlos"
Lead's last name
"Rodriguez"
Lead's email address
"carlos@example.com"
Lead's phone number
"+56987654321"
Lead's company name
"Stark Industries"
Lead's job title
"Manager"
Lead source
"website"
Campaign ID to tag the lead with. Set to null to remove campaign assignment.
"123e4567-e89b-12d3-a456-426614174001"
Key-value pairs to merge into the lead's existing metadata. Existing keys not included in this object are preserved. New keys are added. Matching keys are overwritten with the new value.
{
"estado_lead": "calificado",
"broker_asociado": "Maria Gonzalez"
}
ID of the team member who owns this lead. Must be an active member of your account (GET /team). Set to null to leave the lead unassigned.
"123e4567-e89b-12d3-a456-426614174002"