Skip to main content
POST
/
objects
/
{object_name}
/
attributes
cURL
curl --request POST \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/attributes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "ADDRESS",
  "api_name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "is_required": true,
  "is_unique": true
}
'
import requests

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

payload = {
"type": "ADDRESS",
"api_name": "<string>",
"display_name": "<string>",
"description": "<string>",
"is_required": True,
"is_unique": True
}
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({
type: 'ADDRESS',
api_name: '<string>',
display_name: '<string>',
description: '<string>',
is_required: true,
is_unique: true
})
};

fetch('https://api.unifygtm.com/data/v1/objects/{object_name}/attributes', 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}/attributes",
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([
'type' => 'ADDRESS',
'api_name' => '<string>',
'display_name' => '<string>',
'description' => '<string>',
'is_required' => true,
'is_unique' => true
]),
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}/attributes"

payload := strings.NewReader("{\n \"type\": \"ADDRESS\",\n \"api_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_required\": true,\n \"is_unique\": true\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}/attributes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"ADDRESS\",\n \"api_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_required\": true,\n \"is_unique\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/data/v1/objects/{object_name}/attributes")

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 \"type\": \"ADDRESS\",\n \"api_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_required\": true,\n \"is_unique\": true\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": {
    "type": "ADDRESS",
    "api_name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "is_required": true,
    "is_unique": true
  }
}
{
"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": "attribute_conflict",
"message": "<string>"
}
{
"status": "error",
"message": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

object_name
string
required

Body

application/json

Definition of an attribute on a Unify object.

type
enum<string>
required

The type of value this attribute can hold.

Available options:
ADDRESS
api_name
string
required

This is the unique identifier for the attribute at the API level. It is unique within the object and cannot be changed.

display_name
string
required

This is the user-facing attribute name that will be shown within Unify. It is unique within the object and can be changed at any time.

description
string | null
required

This is a description of the attribute. It is not required but will be shown in the UI to help understand the purpose of the object. Typically, this should be a short sentence or two explaining the attribute.

is_required
boolean
required

Whether the attribute is required.

is_unique
boolean
required

Whether the attribute is unique.

Response

Response for a successful create operation.

Response for a successful create operation.

status
enum<string>
required
Available options:
success
data
object
required

Definition of an attribute on a Unify object.