Update record

cURL

curl --request PATCH \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "data": {}
}'

import requests

url = "https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_id}"

payload = { "data": {} }
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({data: {}})
};

fetch('https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_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.unifygtm.com/data/v1/objects/{object_name}/records/{record_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([
    'data' => [
        
    ]
  ]),
  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.unifygtm.com/data/v1/objects/{object_name}/records/{record_id}"

	payload := strings.NewReader("{\n  \"data\": {}\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.unifygtm.com/data/v1/objects/{object_name}/records/{record_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_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  \"data\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "object": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "attributes": {}
  }
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "object_not_found",
  "message": "<string>"
}

{
  "status": "record_conflict",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

{
  "status": "service_unavailable",
  "message": "<string>"
}

PATCH

data

objects

{object_name}

records

{record_id}

cURL

curl --request PATCH \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "data": {}
}'

import requests

url = "https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_id}"

payload = { "data": {} }
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({data: {}})
};

fetch('https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_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.unifygtm.com/data/v1/objects/{object_name}/records/{record_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([
    'data' => [
        
    ]
  ]),
  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.unifygtm.com/data/v1/objects/{object_name}/records/{record_id}"

	payload := strings.NewReader("{\n  \"data\": {}\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.unifygtm.com/data/v1/objects/{object_name}/records/{record_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/data/v1/objects/{object_name}/records/{record_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  \"data\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "object": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "attributes": {}
  }
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "object_not_found",
  "message": "<string>"
}

{
  "status": "record_conflict",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

{
  "status": "service_unavailable",
  "message": "<string>"
}

Overview

The update method modifies an existing record by its unique ID. You can provide values for any attributes you want to update in the request body. Attributes not included in the request will remain unchanged. If the record doesn’t exist, the API will return a 404 error. This method will not create a new record. If you want to create a record if it doesn’t exist, use the upsert method instead.

This method will overwrite existing values on the record, which may be undesirable. If you want a safer alternative, use the upsert method and pass update_if_empty instead.

Examples

Update a company

This updates specific fields on a company record:

PATCH /objects/company/records/11b41071-1ac7-4419-b3bd-3da132502826

{
  "status": "Inactive",
  "description": "An updated description for this company."
}

{
  "status": "success",
  "data": {
    "object": "company",
    "id": "11b41071-1ac7-4419-b3bd-3da132502826",
    "created_at": "2025-09-04T01:23:45Z",
    "updated_at": "2025-09-04T01:23:45Z",
    "attributes": {
      "name": "Unify",
      "domain": "unifygtm.com",
      "status": "Inactive",
      "description": "An updated description for this company."
      // ...
    }
  }
}

This updates only the status and description fields on the company. All other fields remain unchanged.

Update a person

This updates a person’s job title and associated company:

PATCH /objects/person/records/5ce127ba-8d7e-42d0-9e60-76017a04caec

{
  "title": "Senior Developer",
  "company": {
    "id": "11b41071-1ac7-4419-b3bd-3da132502826"
  }
}

{
  "status": "success",
  "data": {
    "object": "person",
    "id": "5ce127ba-8d7e-42d0-9e60-76017a04caec",
    "created_at": "2025-09-04T01:23:45Z",
    "updated_at": "2025-09-04T01:23:45Z",
    "attributes": {
      "first_name": "Austin",
      "last_name": "Hughes",
      "email": "austinhughes@unifygtm.com",
      "title": "Senior Developer",
      "company": "11b41071-1ac7-4419-b3bd-3da132502826"
      // ...
    }
  }
}

In this case, we knew the exact ID of the company we wanted to link this person to, but you could also use a nested match or upsert if desired.

Update a custom record

This updates fields on a custom object record:

PATCH /objects/product_user/records/e624b659-7a50-4925-9a49-dc2dae8dcb60

{
  "plan": "enterprise",
  "last_login": "2024-01-15T10:30:00Z"
}

{
  "status": "success",
  "data": {
    "object": "product_user",
    "id": "e624b659-7a50-4925-9a49-dc2dae8dcb60",
    "created_at": "2025-09-04T01:23:45Z",
    "updated_at": "2025-09-04T01:23:45Z",
    "attributes": {
      "user_id": "6b2a2761-3cbe-481f-8a1e-b24859c674f8",
      "full_name": "Bob Smith",
      "email_address": "bob.smith@gmail.com",
      "plan": "enterprise",
      "last_login": "2024-01-15T10:30:00Z"
      // ...
    }
  }
}

Usage

Authorizations

x-api-key

string

header

required

Path Parameters

object_name

string

required

The API name of an object, e.g. company, person, opportunity, or a custom object's API name.

record_id

string

required

Query Parameters

validation_mode

enum<string>

Validation mode for request data.

strict: Reject requests if any attribute is invalid or unrecognized.
ignore_invalid: Ignore unknown attributes and omit invalid values for optional attributes. Reject requests with an invalid body structure or invalid required attributes.

Available options:

strict,

ignore_invalid

Body

application/json

Request body for updating a record.

data

object

required

The attribute values to update. Omitted attributes retain their existing values.

Response

Response for a successful update operation.

status

enum<string>

required

Available options:

success

data

object

required

Show child attributes

⌘I

Unify Platform

MCP

Developer Guides

API Reference

SDKs

Update record

Overview

Examples

Usage

Authorizations

Path Parameters

Query Parameters

Body

Response

​Overview

​Examples

​Usage

Authorizations

Path Parameters

Query Parameters

Body

Response

Overview

Examples

Usage