Objects
Update a single custom field
Updates one custom field on an existing object. This is the legacy endpoint —
for updating multiple fields at once, use PATCH instead.
POST
/
api
/
objects
/
{objectType}
Update a single custom field
curl --request POST \
--url https://app.useitem.io/api/objects/{objectType} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"fieldName": "custom_score",
"fieldValue": 95,
"id": 123,
"email": "alex@acme.com"
}
'import requests
url = "https://app.useitem.io/api/objects/{objectType}"
payload = {
"fieldName": "custom_score",
"fieldValue": 95,
"id": 123,
"email": "alex@acme.com"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({fieldName: 'custom_score', fieldValue: 95, id: 123, email: 'alex@acme.com'})
};
fetch('https://app.useitem.io/api/objects/{objectType}', 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://app.useitem.io/api/objects/{objectType}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fieldName' => 'custom_score',
'fieldValue' => 95,
'id' => 123,
'email' => 'alex@acme.com'
]),
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://app.useitem.io/api/objects/{objectType}"
payload := strings.NewReader("{\n \"fieldName\": \"custom_score\",\n \"fieldValue\": 95,\n \"id\": 123,\n \"email\": \"alex@acme.com\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.useitem.io/api/objects/{objectType}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldName\": \"custom_score\",\n \"fieldValue\": 95,\n \"id\": 123,\n \"email\": \"alex@acme.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useitem.io/api/objects/{objectType}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldName\": \"custom_score\",\n \"fieldValue\": 95,\n \"id\": 123,\n \"email\": \"alex@acme.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "Alex Johnson",
"email": "alex@acme.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"message": "Updated custom field 'custom_score' for contact"
}{
"error": "Object not found"
}{
"error": "Object not found"
}{
"error": "Object not found"
}Authorizations
Your organization's API key (starts with sk_live_)
Path Parameters
The object type slug. Use contacts for People, companies for Companies,
or the slug of a Custom Object (e.g., deals, tickets).
Singular forms (contact, company) are also accepted.
Body
application/json
Response
Field updated
A flat object containing all fields. System fields (name, email, phone, etc.) and
custom fields are merged into a single level — the custom_fields JSON column is
flattened so every field is a top-level key.
Show child attributes
Show child attributes
Example:
"Updated custom field 'custom_score' for contact"
⌘I
Update a single custom field
curl --request POST \
--url https://app.useitem.io/api/objects/{objectType} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"fieldName": "custom_score",
"fieldValue": 95,
"id": 123,
"email": "alex@acme.com"
}
'import requests
url = "https://app.useitem.io/api/objects/{objectType}"
payload = {
"fieldName": "custom_score",
"fieldValue": 95,
"id": 123,
"email": "alex@acme.com"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({fieldName: 'custom_score', fieldValue: 95, id: 123, email: 'alex@acme.com'})
};
fetch('https://app.useitem.io/api/objects/{objectType}', 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://app.useitem.io/api/objects/{objectType}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fieldName' => 'custom_score',
'fieldValue' => 95,
'id' => 123,
'email' => 'alex@acme.com'
]),
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://app.useitem.io/api/objects/{objectType}"
payload := strings.NewReader("{\n \"fieldName\": \"custom_score\",\n \"fieldValue\": 95,\n \"id\": 123,\n \"email\": \"alex@acme.com\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.useitem.io/api/objects/{objectType}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldName\": \"custom_score\",\n \"fieldValue\": 95,\n \"id\": 123,\n \"email\": \"alex@acme.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useitem.io/api/objects/{objectType}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldName\": \"custom_score\",\n \"fieldValue\": 95,\n \"id\": 123,\n \"email\": \"alex@acme.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "Alex Johnson",
"email": "alex@acme.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"message": "Updated custom field 'custom_score' for contact"
}{
"error": "Object not found"
}{
"error": "Object not found"
}{
"error": "Object not found"
}