Create record

cURL

curl --request POST \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/records \
  --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"

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

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

	payload := strings.NewReader("{\n  \"data\": {}\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://api.unifygtm.com/data/v1/objects/{object_name}/records")
  .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")

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  \"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>"
}

POST

data

objects

{object_name}

records

cURL

curl --request POST \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/records \
  --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"

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

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

	payload := strings.NewReader("{\n  \"data\": {}\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://api.unifygtm.com/data/v1/objects/{object_name}/records")
  .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")

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  \"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

Create a record in a standard or custom object. Put attribute values inside data and include all required attributes defined on the object. A conflicting unique value returns an error. If your workflow should update an existing record or create one when missing, use Upsert record.

Examples

Set UNIFY_API_KEY to your API key.

Create a company

This example uses synthetic company data:

curl --request POST \
  --url "https://api.unifygtm.com/data/v1/objects/company/records" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "data": {
    "name": "Northstar Labs",
    "domain": "northstar.example",
    "description": "Software for managing laboratory operations."
  }
}'

The response contains the new record in data. Save data.id for later updates or list membership operations.

Create a person at an existing company

A nested match finds the company by its unique domain. Replace these example values with the person’s details and a company already in your workspace.

curl --request POST \
  --url "https://api.unifygtm.com/data/v1/objects/person/records" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "data": {
    "first_name": "Alex",
    "last_name": "Morgan",
    "email": "alex@northstar.example",
    "title": "Operations director",
    "company": {
      "match": {
        "domain": "northstar.example"
      }
    }
  }
}'

If the referenced company is missing, its reference resolves to null. To create the company when needed, include a nested create:

{
  "match": { "domain": "northstar.example" },
  "create": { "name": "Northstar Labs", "domain": "northstar.example" }
}

Use this object as the value of data.company in the person request.

Create a custom record

Suppose you’ve defined a product_user object with user_id, full_name, email_address, and plan attributes. Use those attributes’ API names in data:

curl --request POST \
  --url "https://api.unifygtm.com/data/v1/objects/product_user/records" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "data": {
    "user_id": "trial-user-1042",
    "full_name": "Alex Morgan",
    "email_address": "alex@northstar.example",
    "plan": "free_tier"
  }
}'

Create the object and its attributes before sending this request. Match each value to the attribute’s type and use valid options for select attributes.

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.

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 creating a record.

data

object

required

The attribute values for the new record.

All required attributes on the object must be included.

Response

Response for a successful create operation.

status

enum<string>

required

Available options:

success

data

object

required

Show child attributes

⌘I

Unify platform

MCP

Developer guides

API reference

SDKs

Create record

Overview

Examples

Authorizations

Path Parameters

Query Parameters

Body

Response

​Overview

​Examples

Authorizations

Path Parameters

Query Parameters

Body

Response

Overview

Examples