Leads
Update lead
Update an existing lead.
You can changed the partner team member assigned on the lead using the assignedContactEmail prop.This has to be the email address of an existing team member in the partner’s team.
PATCH
/
v3
/
leads
/
{id}
Update lead
curl --request PATCH \
--url https://api.example.com/v3/leads/{id} \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"deadLine": "2023-11-07T05:31:56Z",
"properties": {},
"currency": "<string>",
"assignedContactEmail": "<string>"
}
'import requests
url = "https://api.example.com/v3/leads/{id}"
payload = {
"deadLine": "2023-11-07T05:31:56Z",
"properties": {},
"currency": "<string>",
"assignedContactEmail": "<string>"
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
deadLine: '2023-11-07T05:31:56Z',
properties: {},
currency: '<string>',
assignedContactEmail: '<string>'
})
};
fetch('https://api.example.com/v3/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.example.com/v3/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([
'deadLine' => '2023-11-07T05:31:56Z',
'properties' => [
],
'currency' => '<string>',
'assignedContactEmail' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+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://api.example.com/v3/leads/{id}"
payload := strings.NewReader("{\n \"deadLine\": \"2023-11-07T05:31:56Z\",\n \"properties\": {},\n \"currency\": \"<string>\",\n \"assignedContactEmail\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json-patch+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.example.com/v3/leads/{id}")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"deadLine\": \"2023-11-07T05:31:56Z\",\n \"properties\": {},\n \"currency\": \"<string>\",\n \"assignedContactEmail\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/leads/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"deadLine\": \"2023-11-07T05:31:56Z\",\n \"properties\": {},\n \"currency\": \"<string>\",\n \"assignedContactEmail\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"creationDate": "2023-11-07T05:31:56Z",
"properties": {},
"partnerId": 123,
"sourcePartnerId": 123,
"userPartnerOwnerId": 123,
"dealId": 123,
"customerId": 123,
"deadLine": "2023-11-07T05:31:56Z",
"assignedDate": "2023-11-07T05:31:56Z",
"acceptedDate": "2023-11-07T05:31:56Z",
"refusedDate": "2023-11-07T05:31:56Z",
"convertedDate": "2023-11-07T05:31:56Z",
"abandonedDate": "2023-11-07T05:31:56Z",
"status": "Unknown",
"partnerName": "<string>",
"dealName": "<string>",
"customerName": "<string>",
"source": "Unknown",
"transferredLeadId": 123,
"currency": "<string>",
"ownerUserId": 123,
"owner": {
"id": 123,
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
}
}Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Response
Lead updated
Update lead
curl --request PATCH \
--url https://api.example.com/v3/leads/{id} \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"deadLine": "2023-11-07T05:31:56Z",
"properties": {},
"currency": "<string>",
"assignedContactEmail": "<string>"
}
'import requests
url = "https://api.example.com/v3/leads/{id}"
payload = {
"deadLine": "2023-11-07T05:31:56Z",
"properties": {},
"currency": "<string>",
"assignedContactEmail": "<string>"
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
deadLine: '2023-11-07T05:31:56Z',
properties: {},
currency: '<string>',
assignedContactEmail: '<string>'
})
};
fetch('https://api.example.com/v3/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.example.com/v3/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([
'deadLine' => '2023-11-07T05:31:56Z',
'properties' => [
],
'currency' => '<string>',
'assignedContactEmail' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+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://api.example.com/v3/leads/{id}"
payload := strings.NewReader("{\n \"deadLine\": \"2023-11-07T05:31:56Z\",\n \"properties\": {},\n \"currency\": \"<string>\",\n \"assignedContactEmail\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json-patch+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.example.com/v3/leads/{id}")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"deadLine\": \"2023-11-07T05:31:56Z\",\n \"properties\": {},\n \"currency\": \"<string>\",\n \"assignedContactEmail\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/leads/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"deadLine\": \"2023-11-07T05:31:56Z\",\n \"properties\": {},\n \"currency\": \"<string>\",\n \"assignedContactEmail\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"creationDate": "2023-11-07T05:31:56Z",
"properties": {},
"partnerId": 123,
"sourcePartnerId": 123,
"userPartnerOwnerId": 123,
"dealId": 123,
"customerId": 123,
"deadLine": "2023-11-07T05:31:56Z",
"assignedDate": "2023-11-07T05:31:56Z",
"acceptedDate": "2023-11-07T05:31:56Z",
"refusedDate": "2023-11-07T05:31:56Z",
"convertedDate": "2023-11-07T05:31:56Z",
"abandonedDate": "2023-11-07T05:31:56Z",
"status": "Unknown",
"partnerName": "<string>",
"dealName": "<string>",
"customerName": "<string>",
"source": "Unknown",
"transferredLeadId": 123,
"currency": "<string>",
"ownerUserId": 123,
"owner": {
"id": 123,
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
}
}