Update a company
curl --request PATCH \
--url https://api.heffl.com/api/v2/companies/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"taxNumber": "<string>",
"website": "<string>",
"description": "<string>",
"linkedin": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"industries": [
"<string>"
],
"foundedYear": 1801,
"currency": "<string>",
"openingBalance": 1,
"showJobAmountToWorker": true,
"isClientPortalEnabled": true,
"internalNotes": "<string>",
"stageId": "<string>",
"ownerUserId": "<string>",
"vendorId": "<string>",
"sourceId": "<string>",
"tags": [
"<string>"
],
"billingAddress": {
"address": "<string>",
"city": "<string>",
"landmark": "<string>",
"state": "<string>",
"country": "<string>",
"postalCode": "<string>",
"latitude": 0,
"longitude": 0,
"googleMapsLink": "<string>",
"googleMapsPlaceId": "<string>"
},
"primaryContact": {}
}
'import requests
url = "https://api.heffl.com/api/v2/companies/{id}"
payload = {
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"taxNumber": "<string>",
"website": "<string>",
"description": "<string>",
"linkedin": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"industries": ["<string>"],
"foundedYear": 1801,
"currency": "<string>",
"openingBalance": 1,
"showJobAmountToWorker": True,
"isClientPortalEnabled": True,
"internalNotes": "<string>",
"stageId": "<string>",
"ownerUserId": "<string>",
"vendorId": "<string>",
"sourceId": "<string>",
"tags": ["<string>"],
"billingAddress": {
"address": "<string>",
"city": "<string>",
"landmark": "<string>",
"state": "<string>",
"country": "<string>",
"postalCode": "<string>",
"latitude": 0,
"longitude": 0,
"googleMapsLink": "<string>",
"googleMapsPlaceId": "<string>"
},
"primaryContact": {}
}
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({
name: '<string>',
email: '[email protected]',
phone: '<string>',
taxNumber: '<string>',
website: '<string>',
description: '<string>',
linkedin: '<string>',
twitter: '<string>',
facebook: '<string>',
instagram: '<string>',
industries: ['<string>'],
foundedYear: 1801,
currency: '<string>',
openingBalance: 1,
showJobAmountToWorker: true,
isClientPortalEnabled: true,
internalNotes: '<string>',
stageId: '<string>',
ownerUserId: '<string>',
vendorId: '<string>',
sourceId: '<string>',
tags: ['<string>'],
billingAddress: {
address: '<string>',
city: '<string>',
landmark: '<string>',
state: '<string>',
country: '<string>',
postalCode: '<string>',
latitude: 0,
longitude: 0,
googleMapsLink: '<string>',
googleMapsPlaceId: '<string>'
},
primaryContact: {}
})
};
fetch('https://api.heffl.com/api/v2/companies/{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/v2/companies/{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([
'name' => '<string>',
'email' => '[email protected]',
'phone' => '<string>',
'taxNumber' => '<string>',
'website' => '<string>',
'description' => '<string>',
'linkedin' => '<string>',
'twitter' => '<string>',
'facebook' => '<string>',
'instagram' => '<string>',
'industries' => [
'<string>'
],
'foundedYear' => 1801,
'currency' => '<string>',
'openingBalance' => 1,
'showJobAmountToWorker' => true,
'isClientPortalEnabled' => true,
'internalNotes' => '<string>',
'stageId' => '<string>',
'ownerUserId' => '<string>',
'vendorId' => '<string>',
'sourceId' => '<string>',
'tags' => [
'<string>'
],
'billingAddress' => [
'address' => '<string>',
'city' => '<string>',
'landmark' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postalCode' => '<string>',
'latitude' => 0,
'longitude' => 0,
'googleMapsLink' => '<string>',
'googleMapsPlaceId' => '<string>'
],
'primaryContact' => [
]
]),
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/v2/companies/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"industries\": [\n \"<string>\"\n ],\n \"foundedYear\": 1801,\n \"currency\": \"<string>\",\n \"openingBalance\": 1,\n \"showJobAmountToWorker\": true,\n \"isClientPortalEnabled\": true,\n \"internalNotes\": \"<string>\",\n \"stageId\": \"<string>\",\n \"ownerUserId\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"billingAddress\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"landmark\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"googleMapsLink\": \"<string>\",\n \"googleMapsPlaceId\": \"<string>\"\n },\n \"primaryContact\": {}\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/v2/companies/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"industries\": [\n \"<string>\"\n ],\n \"foundedYear\": 1801,\n \"currency\": \"<string>\",\n \"openingBalance\": 1,\n \"showJobAmountToWorker\": true,\n \"isClientPortalEnabled\": true,\n \"internalNotes\": \"<string>\",\n \"stageId\": \"<string>\",\n \"ownerUserId\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"billingAddress\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"landmark\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"googleMapsLink\": \"<string>\",\n \"googleMapsPlaceId\": \"<string>\"\n },\n \"primaryContact\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/companies/{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 \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"industries\": [\n \"<string>\"\n ],\n \"foundedYear\": 1801,\n \"currency\": \"<string>\",\n \"openingBalance\": 1,\n \"showJobAmountToWorker\": true,\n \"isClientPortalEnabled\": true,\n \"internalNotes\": \"<string>\",\n \"stageId\": \"<string>\",\n \"ownerUserId\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"billingAddress\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"landmark\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"googleMapsLink\": \"<string>\",\n \"googleMapsPlaceId\": \"<string>\"\n },\n \"primaryContact\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"number": "<string>",
"openingBalance": 123,
"showJobAmountToWorker": true,
"isClientPortalEnabled": true,
"paymentTerm": "DUE_ON_RECEIPT",
"ownerName": "<string>",
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"billingAddress": {
"address": "<string>",
"city": "<string>",
"landmark": "<string>",
"postalCode": "<string>",
"state": "<string>",
"stateCode": "<string>",
"country": "<string>",
"countryCode": "<string>",
"latitude": 123,
"longitude": 123,
"googleMapsLink": "<string>",
"googleMapsPlaceId": "<string>"
},
"contacts": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"jobTitle": "<string>",
"isPrimary": true
}
],
"type": "contact",
"email": "<string>",
"phone": "<string>",
"taxNumber": "<string>",
"website": "<string>",
"description": "<string>",
"industries": [
"<string>"
],
"employeesCountRange": "1-10",
"revenueRange": "under-1m",
"foundedYear": 123,
"linkedin": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"stageId": "<string>",
"stageName": "<string>",
"ownerUserId": "<string>",
"sourceId": "<string>",
"sourceName": "<string>",
"currency": "<string>",
"taxTreatment": "vat_registered",
"profileImage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastActivityAt": "2023-11-07T05:31:56Z",
"lastContactedAt": "2023-11-07T05:31:56Z",
"enrichedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Companies
Update a company
Updates an existing company. Only provided fields will be updated. When tags is provided, it replaces the full set. Custom field values use cf_* keys — see the Custom fields guide.
PATCH
/
companies
/
{id}
Update a company
curl --request PATCH \
--url https://api.heffl.com/api/v2/companies/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"taxNumber": "<string>",
"website": "<string>",
"description": "<string>",
"linkedin": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"industries": [
"<string>"
],
"foundedYear": 1801,
"currency": "<string>",
"openingBalance": 1,
"showJobAmountToWorker": true,
"isClientPortalEnabled": true,
"internalNotes": "<string>",
"stageId": "<string>",
"ownerUserId": "<string>",
"vendorId": "<string>",
"sourceId": "<string>",
"tags": [
"<string>"
],
"billingAddress": {
"address": "<string>",
"city": "<string>",
"landmark": "<string>",
"state": "<string>",
"country": "<string>",
"postalCode": "<string>",
"latitude": 0,
"longitude": 0,
"googleMapsLink": "<string>",
"googleMapsPlaceId": "<string>"
},
"primaryContact": {}
}
'import requests
url = "https://api.heffl.com/api/v2/companies/{id}"
payload = {
"name": "<string>",
"email": "[email protected]",
"phone": "<string>",
"taxNumber": "<string>",
"website": "<string>",
"description": "<string>",
"linkedin": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"industries": ["<string>"],
"foundedYear": 1801,
"currency": "<string>",
"openingBalance": 1,
"showJobAmountToWorker": True,
"isClientPortalEnabled": True,
"internalNotes": "<string>",
"stageId": "<string>",
"ownerUserId": "<string>",
"vendorId": "<string>",
"sourceId": "<string>",
"tags": ["<string>"],
"billingAddress": {
"address": "<string>",
"city": "<string>",
"landmark": "<string>",
"state": "<string>",
"country": "<string>",
"postalCode": "<string>",
"latitude": 0,
"longitude": 0,
"googleMapsLink": "<string>",
"googleMapsPlaceId": "<string>"
},
"primaryContact": {}
}
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({
name: '<string>',
email: '[email protected]',
phone: '<string>',
taxNumber: '<string>',
website: '<string>',
description: '<string>',
linkedin: '<string>',
twitter: '<string>',
facebook: '<string>',
instagram: '<string>',
industries: ['<string>'],
foundedYear: 1801,
currency: '<string>',
openingBalance: 1,
showJobAmountToWorker: true,
isClientPortalEnabled: true,
internalNotes: '<string>',
stageId: '<string>',
ownerUserId: '<string>',
vendorId: '<string>',
sourceId: '<string>',
tags: ['<string>'],
billingAddress: {
address: '<string>',
city: '<string>',
landmark: '<string>',
state: '<string>',
country: '<string>',
postalCode: '<string>',
latitude: 0,
longitude: 0,
googleMapsLink: '<string>',
googleMapsPlaceId: '<string>'
},
primaryContact: {}
})
};
fetch('https://api.heffl.com/api/v2/companies/{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/v2/companies/{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([
'name' => '<string>',
'email' => '[email protected]',
'phone' => '<string>',
'taxNumber' => '<string>',
'website' => '<string>',
'description' => '<string>',
'linkedin' => '<string>',
'twitter' => '<string>',
'facebook' => '<string>',
'instagram' => '<string>',
'industries' => [
'<string>'
],
'foundedYear' => 1801,
'currency' => '<string>',
'openingBalance' => 1,
'showJobAmountToWorker' => true,
'isClientPortalEnabled' => true,
'internalNotes' => '<string>',
'stageId' => '<string>',
'ownerUserId' => '<string>',
'vendorId' => '<string>',
'sourceId' => '<string>',
'tags' => [
'<string>'
],
'billingAddress' => [
'address' => '<string>',
'city' => '<string>',
'landmark' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postalCode' => '<string>',
'latitude' => 0,
'longitude' => 0,
'googleMapsLink' => '<string>',
'googleMapsPlaceId' => '<string>'
],
'primaryContact' => [
]
]),
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/v2/companies/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"industries\": [\n \"<string>\"\n ],\n \"foundedYear\": 1801,\n \"currency\": \"<string>\",\n \"openingBalance\": 1,\n \"showJobAmountToWorker\": true,\n \"isClientPortalEnabled\": true,\n \"internalNotes\": \"<string>\",\n \"stageId\": \"<string>\",\n \"ownerUserId\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"billingAddress\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"landmark\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"googleMapsLink\": \"<string>\",\n \"googleMapsPlaceId\": \"<string>\"\n },\n \"primaryContact\": {}\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/v2/companies/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"industries\": [\n \"<string>\"\n ],\n \"foundedYear\": 1801,\n \"currency\": \"<string>\",\n \"openingBalance\": 1,\n \"showJobAmountToWorker\": true,\n \"isClientPortalEnabled\": true,\n \"internalNotes\": \"<string>\",\n \"stageId\": \"<string>\",\n \"ownerUserId\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"billingAddress\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"landmark\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"googleMapsLink\": \"<string>\",\n \"googleMapsPlaceId\": \"<string>\"\n },\n \"primaryContact\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/companies/{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 \"name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"industries\": [\n \"<string>\"\n ],\n \"foundedYear\": 1801,\n \"currency\": \"<string>\",\n \"openingBalance\": 1,\n \"showJobAmountToWorker\": true,\n \"isClientPortalEnabled\": true,\n \"internalNotes\": \"<string>\",\n \"stageId\": \"<string>\",\n \"ownerUserId\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"sourceId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"billingAddress\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"landmark\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"googleMapsLink\": \"<string>\",\n \"googleMapsPlaceId\": \"<string>\"\n },\n \"primaryContact\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"number": "<string>",
"openingBalance": 123,
"showJobAmountToWorker": true,
"isClientPortalEnabled": true,
"paymentTerm": "DUE_ON_RECEIPT",
"ownerName": "<string>",
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"billingAddress": {
"address": "<string>",
"city": "<string>",
"landmark": "<string>",
"postalCode": "<string>",
"state": "<string>",
"stateCode": "<string>",
"country": "<string>",
"countryCode": "<string>",
"latitude": 123,
"longitude": 123,
"googleMapsLink": "<string>",
"googleMapsPlaceId": "<string>"
},
"contacts": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"jobTitle": "<string>",
"isPrimary": true
}
],
"type": "contact",
"email": "<string>",
"phone": "<string>",
"taxNumber": "<string>",
"website": "<string>",
"description": "<string>",
"industries": [
"<string>"
],
"employeesCountRange": "1-10",
"revenueRange": "under-1m",
"foundedYear": 123,
"linkedin": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"stageId": "<string>",
"stageName": "<string>",
"ownerUserId": "<string>",
"sourceId": "<string>",
"sourceName": "<string>",
"currency": "<string>",
"taxTreatment": "vat_registered",
"profileImage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastActivityAt": "2023-11-07T05:31:56Z",
"lastContactedAt": "2023-11-07T05:31:56Z",
"enrichedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
API key for authentication. Get yours at app.heffl.com/settings/developers
Path Parameters
Company ID
Body
application/json
Company name
Email address
Phone number with country code
Tax number
Website URL
Description
LinkedIn URL
X / Twitter URL
Facebook URL
Instagram URL
Industries
Employee count bucket
Available options:
1-10, 11-50, 51-200, 201-500, 501-1K, 1K-5K, 5K-10K, over-10K Annual revenue bucket
Available options:
under-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, over-1b Year the company was founded
Required range:
x >= 1800VAT treatment (GCC)
Available options:
vat_registered, vat_not_registered, gcc_vat_registered, gcc_vat_not_registered, non_gcc, dz_vat_registered, dz_vat_not_registered Default invoice payment term. Null falls back to the team default.
Available options:
DUE_ON_RECEIPT, NET_7, NET_15, NET_30, NET_45, NET_60, END_OF_MONTH, END_OF_NEXT_MONTH, CUSTOM 3-letter ISO currency code
Opening balance
Required range:
x >= 0Whether job amounts are visible to field workers
Whether the client portal is enabled
Internal notes
Client stage ID
Owner user ID
Vendor ID
CRM source ID
Tag IDs (tag_ prefix). Replaces the full set when provided.
Billing address. On update only the keys you send are changed; send null to clear a key. An unrecognised country returns 400; state must be sent together with country.
Show child attributes
Show child attributes
Optional primary contact fields to create or update
Custom field values using cf_* keys (for example cf_industry). Only documented fields and cf_* keys are accepted.
Response
OK
A company with its billing address, tags, owner and contacts. Returned by get, create and update.
Company ID
Company name
Auto-generated company number
Opening balance
Whether job amounts are visible to field workers
Whether the client portal is enabled
Default invoice payment term. Null falls back to the team default.
Available options:
DUE_ON_RECEIPT, NET_7, NET_15, NET_30, NET_45, NET_60, END_OF_MONTH, END_OF_NEXT_MONTH, CUSTOM Owner's full name
Tags on the company
Show child attributes
Show child attributes
Billing address
Show child attributes
Show child attributes
Contacts under this company, primary first
Show child attributes
Show child attributes
Record type (always company for this endpoint)
Available options:
contact, company Email address
Phone number
Tax number
Website URL
Description
Industries
Employee count bucket
Available options:
1-10, 11-50, 51-200, 201-500, 501-1K, 1K-5K, 5K-10K, over-10K Annual revenue bucket
Available options:
under-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, over-1b Year the company was founded
LinkedIn URL
X / Twitter URL
Facebook URL
Instagram URL
Client stage ID
Client stage label
Owner user ID
CRM source ID
CRM source name
Currency code
VAT treatment (GCC)
Available options:
vat_registered, vat_not_registered, gcc_vat_registered, gcc_vat_not_registered, non_gcc, dz_vat_registered, dz_vat_not_registered Profile image URL
When the company was created
When the company was last updated
When the last activity was logged
When the company was last contacted
When the company was last enriched
Custom field values as top-level cf_* keys (for example cf_industry). There is no customFields wrapper.