CRM Companies
Patch crmcompanies
PATCH
/
crm
/
companies
/
{id}
cURL
curl --request PATCH \
--url https://api.example.com/crm/companies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"domain": "<string>",
"industry": "<string>",
"website": "<string>",
"phoneNumber": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressCity": "<string>",
"addressZip": "<string>",
"addressCountry": "<string>",
"notes": "<string>",
"ownerId": "<string>",
"customFields": {}
}
'import requests
url = "https://api.example.com/crm/companies/{id}"
payload = {
"name": "<string>",
"domain": "<string>",
"industry": "<string>",
"website": "<string>",
"phoneNumber": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressCity": "<string>",
"addressZip": "<string>",
"addressCountry": "<string>",
"notes": "<string>",
"ownerId": "<string>",
"customFields": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
domain: '<string>',
industry: '<string>',
website: '<string>',
phoneNumber: '<string>',
addressLine1: '<string>',
addressLine2: '<string>',
addressCity: '<string>',
addressZip: '<string>',
addressCountry: '<string>',
notes: '<string>',
ownerId: '<string>',
customFields: {}
})
};
fetch('https://api.example.com/crm/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.example.com/crm/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>',
'domain' => '<string>',
'industry' => '<string>',
'website' => '<string>',
'phoneNumber' => '<string>',
'addressLine1' => '<string>',
'addressLine2' => '<string>',
'addressCity' => '<string>',
'addressZip' => '<string>',
'addressCountry' => '<string>',
'notes' => '<string>',
'ownerId' => '<string>',
'customFields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/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/crm/companies/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"industry\": \"<string>\",\n \"website\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"addressCity\": \"<string>\",\n \"addressZip\": \"<string>\",\n \"addressCountry\": \"<string>\",\n \"notes\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"customFields\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.example.com/crm/companies/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"industry\": \"<string>\",\n \"website\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"addressCity\": \"<string>\",\n \"addressZip\": \"<string>\",\n \"addressCountry\": \"<string>\",\n \"notes\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"customFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/crm/companies/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"industry\": \"<string>\",\n \"website\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"addressCity\": \"<string>\",\n \"addressZip\": \"<string>\",\n \"addressCountry\": \"<string>\",\n \"notes\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"customFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"companyId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"domain": "<string>",
"industry": "<string>",
"size": "1-10",
"website": "<string>",
"iconUrl": "<string>",
"phoneNumber": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"notes": "<string>",
"description": "<string>",
"ownerId": "<string>",
"customFields": {},
"owner": {
"id": "<string>",
"email": "<string>",
"givenName": "<string>",
"familyName": "<string>"
},
"contactsCount": 123,
"dealsCount": 123,
"totalDealsValue": 123,
"totalDealsCurrency": "<string>"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}Authorizations
ApiKeyJWTApiUserHeader
Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.
Path Parameters
Body
application/json
Maximum string length:
255Maximum string length:
255Maximum string length:
100Available options:
1-10, 11-50, 51-200, 201-500, 501-1000, 1001+ Maximum string length:
500Maximum string length:
50Maximum string length:
255Maximum string length:
255Maximum string length:
100Maximum string length:
20Maximum string length:
100Maximum string length:
10000Values for the company custom fields configured under
GET /crm/settings/custom-fields?recordType=company, keyed by field key.
On update this is a patch: keys you do not send are left alone, and a key
sent as null is removed.
Response
Available options:
1-10, 11-50, 51-200, 201-500, 501-1000, 1001+ Cached brand mark, so lists can anchor on the company's own logo.
Show child attributes
Show child attributes
What the company publishes about itself. Never the seller's own notes.
Show child attributes
Show child attributes
Majority deal currency behind totalDealsValue. Additive: older clients
ignore it and keep their display fallback.
⌘I
cURL
curl --request PATCH \
--url https://api.example.com/crm/companies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"domain": "<string>",
"industry": "<string>",
"website": "<string>",
"phoneNumber": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressCity": "<string>",
"addressZip": "<string>",
"addressCountry": "<string>",
"notes": "<string>",
"ownerId": "<string>",
"customFields": {}
}
'import requests
url = "https://api.example.com/crm/companies/{id}"
payload = {
"name": "<string>",
"domain": "<string>",
"industry": "<string>",
"website": "<string>",
"phoneNumber": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressCity": "<string>",
"addressZip": "<string>",
"addressCountry": "<string>",
"notes": "<string>",
"ownerId": "<string>",
"customFields": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
domain: '<string>',
industry: '<string>',
website: '<string>',
phoneNumber: '<string>',
addressLine1: '<string>',
addressLine2: '<string>',
addressCity: '<string>',
addressZip: '<string>',
addressCountry: '<string>',
notes: '<string>',
ownerId: '<string>',
customFields: {}
})
};
fetch('https://api.example.com/crm/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.example.com/crm/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>',
'domain' => '<string>',
'industry' => '<string>',
'website' => '<string>',
'phoneNumber' => '<string>',
'addressLine1' => '<string>',
'addressLine2' => '<string>',
'addressCity' => '<string>',
'addressZip' => '<string>',
'addressCountry' => '<string>',
'notes' => '<string>',
'ownerId' => '<string>',
'customFields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/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/crm/companies/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"industry\": \"<string>\",\n \"website\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"addressCity\": \"<string>\",\n \"addressZip\": \"<string>\",\n \"addressCountry\": \"<string>\",\n \"notes\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"customFields\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.example.com/crm/companies/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"industry\": \"<string>\",\n \"website\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"addressCity\": \"<string>\",\n \"addressZip\": \"<string>\",\n \"addressCountry\": \"<string>\",\n \"notes\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"customFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/crm/companies/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domain\": \"<string>\",\n \"industry\": \"<string>\",\n \"website\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"addressCity\": \"<string>\",\n \"addressZip\": \"<string>\",\n \"addressCountry\": \"<string>\",\n \"notes\": \"<string>\",\n \"ownerId\": \"<string>\",\n \"customFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"companyId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"domain": "<string>",
"industry": "<string>",
"size": "1-10",
"website": "<string>",
"iconUrl": "<string>",
"phoneNumber": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"notes": "<string>",
"description": "<string>",
"ownerId": "<string>",
"customFields": {},
"owner": {
"id": "<string>",
"email": "<string>",
"givenName": "<string>",
"familyName": "<string>"
},
"contactsCount": 123,
"dealsCount": 123,
"totalDealsValue": 123,
"totalDealsCurrency": "<string>"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}