Update a deal
curl --request PATCH \
--url https://api.heffl.com/api/v1/deals/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"price": 123,
"stageId": "<string>",
"sourceId": "<string>",
"expectedCloseDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.heffl.com/api/v1/deals/{id}"
payload = {
"title": "<string>",
"price": 123,
"stageId": "<string>",
"sourceId": "<string>",
"expectedCloseDate": "2023-11-07T05:31:56Z"
}
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({
title: '<string>',
price: 123,
stageId: '<string>',
sourceId: '<string>',
expectedCloseDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.heffl.com/api/v1/deals/{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.heffl.com/api/v1/deals/{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([
'title' => '<string>',
'price' => 123,
'stageId' => '<string>',
'sourceId' => '<string>',
'expectedCloseDate' => '2023-11-07T05:31:56Z'
]),
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.heffl.com/api/v1/deals/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"price\": 123,\n \"stageId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"expectedCloseDate\": \"2023-11-07T05:31:56Z\"\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.heffl.com/api/v1/deals/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"price\": 123,\n \"stageId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"expectedCloseDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v1/deals/{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 \"title\": \"<string>\",\n \"price\": 123,\n \"stageId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"expectedCloseDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"title": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"number": "<string>",
"price": 123,
"status": "<string>",
"priority": "<string>",
"expectedCloseDate": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"pipelineId": "<string>",
"stageId": "<string>",
"sourceId": "<string>",
"leadId": "<string>",
"customFields": {}
}Deals
Update a deal
Updates an existing deal. Only provided fields will be updated.
PATCH
/
deals
/
{id}
Update a deal
curl --request PATCH \
--url https://api.heffl.com/api/v1/deals/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"price": 123,
"stageId": "<string>",
"sourceId": "<string>",
"expectedCloseDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.heffl.com/api/v1/deals/{id}"
payload = {
"title": "<string>",
"price": 123,
"stageId": "<string>",
"sourceId": "<string>",
"expectedCloseDate": "2023-11-07T05:31:56Z"
}
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({
title: '<string>',
price: 123,
stageId: '<string>',
sourceId: '<string>',
expectedCloseDate: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.heffl.com/api/v1/deals/{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.heffl.com/api/v1/deals/{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([
'title' => '<string>',
'price' => 123,
'stageId' => '<string>',
'sourceId' => '<string>',
'expectedCloseDate' => '2023-11-07T05:31:56Z'
]),
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.heffl.com/api/v1/deals/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"price\": 123,\n \"stageId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"expectedCloseDate\": \"2023-11-07T05:31:56Z\"\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.heffl.com/api/v1/deals/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"price\": 123,\n \"stageId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"expectedCloseDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v1/deals/{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 \"title\": \"<string>\",\n \"price\": 123,\n \"stageId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"expectedCloseDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"title": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"number": "<string>",
"price": 123,
"status": "<string>",
"priority": "<string>",
"expectedCloseDate": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"pipelineId": "<string>",
"stageId": "<string>",
"sourceId": "<string>",
"leadId": "<string>",
"customFields": {}
}Authorizations
API key for authentication. Get yours at app.heffl.com/settings/developers
Path Parameters
Deal public ID
Body
application/json
Deal title
Deal value/price
Pipeline stage public ID
Deal status (ACTIVE, WON, LOST)
Available options:
ACTIVE, WON, LOST Deal priority
Available options:
LOW, MEDIUM, HIGH Deal source public ID
Expected close date
Response
200 - application/json
OK
Deal public ID
Deal title
When the deal was created
Auto-generated deal number
Deal price/value
Deal status
Deal priority
Expected close date
Client public ID
Pipeline public ID
Pipeline stage public ID
Deal source public ID
Lead public ID
Custom field values
Show child attributes
Show child attributes