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

Update a record by ID. Put the attributes you want to change inside data. Supplied values replace existing values, while omitted attributes retain their values. To fill only missing values, use Upsert record with update_if_empty.

Examples

Set UNIFY_API_KEY to your API key.

Update a company description

Replace the example IDs with records from your workspace.

curl --request PATCH \
  --url "https://api.unifygtm.com/data/v1/objects/company/records/73fcb798-9ccd-4138-8f6a-9a801123783c" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "data": {
    "description": "Laboratory operations software for multi-site research teams."
  }
}'

Update a person's job

Update the person’s title and company together. This example references the company by record ID:

curl --request PATCH \
  --url "https://api.unifygtm.com/data/v1/objects/person/records/bf3f4d5e-c995-496f-8774-5a1c58d05197" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "data": {
    "title": "VP of operations",
    "company": {
      "id": "73fcb798-9ccd-4138-8f6a-9a801123783c"
    }
  }
}'

A successful response contains the updated record in data. If the target record does not exist, the API returns 404.

Update a custom record

For a custom object, use its API name in the URL and its attribute API names in data. For example, a product_user object with a plan attribute could use:

{
  "data": { "plan": "enterprise" }
}

The attribute and any referenced select option must already exist.

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

Authorizations

Path Parameters

Query Parameters

Body

Response

​Overview

​Examples

Authorizations

Path Parameters

Query Parameters

Body

Response

Overview

Examples