CRM Contacts
Patch crm
PATCH
/
crm
/
{id}
cURL
curl --request PATCH \
--url https://api.example.com/crm/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"language": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"notes": "<string>",
"title": "<string>",
"employer": "<string>",
"seniority": "<string>",
"function": "<string>",
"location": "<string>",
"tags": [
"<string>"
],
"accountOwnerId": "<string>",
"contactCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crmCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalData": {},
"email": "jsmith@example.com"
}
'import requests
url = "https://api.example.com/crm/{id}"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"language": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"notes": "<string>",
"title": "<string>",
"employer": "<string>",
"seniority": "<string>",
"function": "<string>",
"location": "<string>",
"tags": ["<string>"],
"accountOwnerId": "<string>",
"contactCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crmCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalData": {},
"email": "jsmith@example.com"
}
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({
firstName: '<string>',
lastName: '<string>',
phoneNumber: '<string>',
language: '<string>',
address: {
line1: '<string>',
line2: '<string>',
line3: '<string>',
city: '<string>',
zip: '<string>',
country: '<string>'
},
notes: '<string>',
title: '<string>',
employer: '<string>',
seniority: '<string>',
function: '<string>',
location: '<string>',
tags: ['<string>'],
accountOwnerId: '<string>',
contactCompanyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
crmCompanyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
additionalData: {},
email: 'jsmith@example.com'
})
};
fetch('https://api.example.com/crm/{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/{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([
'firstName' => '<string>',
'lastName' => '<string>',
'phoneNumber' => '<string>',
'language' => '<string>',
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'line3' => '<string>',
'city' => '<string>',
'zip' => '<string>',
'country' => '<string>'
],
'notes' => '<string>',
'title' => '<string>',
'employer' => '<string>',
'seniority' => '<string>',
'function' => '<string>',
'location' => '<string>',
'tags' => [
'<string>'
],
'accountOwnerId' => '<string>',
'contactCompanyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'crmCompanyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'additionalData' => [
],
'email' => 'jsmith@example.com'
]),
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/{id}"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"language\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"title\": \"<string>\",\n \"employer\": \"<string>\",\n \"seniority\": \"<string>\",\n \"function\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"accountOwnerId\": \"<string>\",\n \"contactCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"crmCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalData\": {},\n \"email\": \"jsmith@example.com\"\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/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"language\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"title\": \"<string>\",\n \"employer\": \"<string>\",\n \"seniority\": \"<string>\",\n \"function\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"accountOwnerId\": \"<string>\",\n \"contactCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"crmCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalData\": {},\n \"email\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/crm/{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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"language\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"title\": \"<string>\",\n \"employer\": \"<string>\",\n \"seniority\": \"<string>\",\n \"function\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"accountOwnerId\": \"<string>\",\n \"contactCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"crmCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalData\": {},\n \"email\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"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:
64ISO 639-1, e.g. "de".
Maximum string length:
8Show child attributes
Show child attributes
The attributes the assistant researches, and a person corrects.
Editable here so an accepted suggestion becomes a value somebody owns
rather than a ledger row they can only accept or dismiss. Once a person
edits one, RecordFactService treats it as human-owned and stops
overwriting it.
Nullable on purpose: the client clears a contact's company by sending
null, so @IsUUID alone would reject the only way to unset it.
Partial map of custom data field values to merge into the contact's additionalData. Set a value to null to remove the key.
Response
⌘I
cURL
curl --request PATCH \
--url https://api.example.com/crm/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"language": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"notes": "<string>",
"title": "<string>",
"employer": "<string>",
"seniority": "<string>",
"function": "<string>",
"location": "<string>",
"tags": [
"<string>"
],
"accountOwnerId": "<string>",
"contactCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crmCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalData": {},
"email": "jsmith@example.com"
}
'import requests
url = "https://api.example.com/crm/{id}"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"language": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"notes": "<string>",
"title": "<string>",
"employer": "<string>",
"seniority": "<string>",
"function": "<string>",
"location": "<string>",
"tags": ["<string>"],
"accountOwnerId": "<string>",
"contactCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crmCompanyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalData": {},
"email": "jsmith@example.com"
}
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({
firstName: '<string>',
lastName: '<string>',
phoneNumber: '<string>',
language: '<string>',
address: {
line1: '<string>',
line2: '<string>',
line3: '<string>',
city: '<string>',
zip: '<string>',
country: '<string>'
},
notes: '<string>',
title: '<string>',
employer: '<string>',
seniority: '<string>',
function: '<string>',
location: '<string>',
tags: ['<string>'],
accountOwnerId: '<string>',
contactCompanyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
crmCompanyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
additionalData: {},
email: 'jsmith@example.com'
})
};
fetch('https://api.example.com/crm/{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/{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([
'firstName' => '<string>',
'lastName' => '<string>',
'phoneNumber' => '<string>',
'language' => '<string>',
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'line3' => '<string>',
'city' => '<string>',
'zip' => '<string>',
'country' => '<string>'
],
'notes' => '<string>',
'title' => '<string>',
'employer' => '<string>',
'seniority' => '<string>',
'function' => '<string>',
'location' => '<string>',
'tags' => [
'<string>'
],
'accountOwnerId' => '<string>',
'contactCompanyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'crmCompanyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'additionalData' => [
],
'email' => 'jsmith@example.com'
]),
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/{id}"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"language\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"title\": \"<string>\",\n \"employer\": \"<string>\",\n \"seniority\": \"<string>\",\n \"function\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"accountOwnerId\": \"<string>\",\n \"contactCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"crmCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalData\": {},\n \"email\": \"jsmith@example.com\"\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/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"language\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"title\": \"<string>\",\n \"employer\": \"<string>\",\n \"seniority\": \"<string>\",\n \"function\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"accountOwnerId\": \"<string>\",\n \"contactCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"crmCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalData\": {},\n \"email\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/crm/{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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"language\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"line3\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"notes\": \"<string>\",\n \"title\": \"<string>\",\n \"employer\": \"<string>\",\n \"seniority\": \"<string>\",\n \"function\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"accountOwnerId\": \"<string>\",\n \"contactCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"crmCompanyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalData\": {},\n \"email\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}