Create property

curl --request POST \
  --url https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessAllowlist": [
    {
      "entityId": "<string>"
    }
  ],
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "sensitiveDataCategories": [
    "<string>"
  ],
  "validationRules": [
    {
      "ruleArguments": [
        "<string>"
      ],
      "shouldApplyNormalization": true
    }
  ],
  "calculationFormula": "<string>",
  "currencyPropertyName": "<string>",
  "dataEntryInstructions": "<string>",
  "defaultValue": "<string>",
  "description": "<string>",
  "formField": true,
  "hasUniqueValue": true
}
'

import requests

url = "https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties"

payload = {
    "accessAllowlist": [{ "entityId": "<string>" }],
    "groupName": "<string>",
    "label": "<string>",
    "name": "<string>",
    "options": [
        {
            "description": "<string>",
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>"
        }
    ],
    "sensitiveDataCategories": ["<string>"],
    "validationRules": [
        {
            "ruleArguments": ["<string>"],
            "shouldApplyNormalization": True
        }
    ],
    "calculationFormula": "<string>",
    "currencyPropertyName": "<string>",
    "dataEntryInstructions": "<string>",
    "defaultValue": "<string>",
    "description": "<string>",
    "formField": True,
    "hasUniqueValue": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessAllowlist: [{entityId: '<string>'}],
    groupName: '<string>',
    label: '<string>',
    name: '<string>',
    options: [
      {
        description: '<string>',
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>'
      }
    ],
    sensitiveDataCategories: ['<string>'],
    validationRules: [{ruleArguments: ['<string>'], shouldApplyNormalization: true}],
    calculationFormula: '<string>',
    currencyPropertyName: '<string>',
    dataEntryInstructions: '<string>',
    defaultValue: '<string>',
    description: '<string>',
    formField: true,
    hasUniqueValue: true
  })
};

fetch('https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties', 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.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties",
  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([
    'accessAllowlist' => [
        [
                'entityId' => '<string>'
        ]
    ],
    'groupName' => '<string>',
    'label' => '<string>',
    'name' => '<string>',
    'options' => [
        [
                'description' => '<string>',
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>'
        ]
    ],
    'sensitiveDataCategories' => [
        '<string>'
    ],
    'validationRules' => [
        [
                'ruleArguments' => [
                                '<string>'
                ],
                'shouldApplyNormalization' => true
        ]
    ],
    'calculationFormula' => '<string>',
    'currencyPropertyName' => '<string>',
    'dataEntryInstructions' => '<string>',
    'defaultValue' => '<string>',
    'description' => '<string>',
    'formField' => true,
    'hasUniqueValue' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties"

	payload := strings.NewReader("{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"description\": \"<string>\",\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sensitiveDataCategories\": [\n    \"<string>\"\n  ],\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ],\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"dataEntryInstructions\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"description\": \"<string>\",\n  \"formField\": true,\n  \"hasUniqueValue\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"description\": \"<string>\",\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sensitiveDataCategories\": [\n    \"<string>\"\n  ],\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ],\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"dataEntryInstructions\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"description\": \"<string>\",\n  \"formField\": true,\n  \"hasUniqueValue\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"description\": \"<string>\",\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sensitiveDataCategories\": [\n    \"<string>\"\n  ],\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ],\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"dataEntryInstructions\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"description\": \"<string>\",\n  \"formField\": true,\n  \"hasUniqueValue\": true\n}"

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

{
  "category": "HUBSPOT_DEFINED",
  "fieldType": "BOOLEANCHECKBOX",
  "name": "<string>",
  "type": "BOOL",
  "accessAllowlist": [
    {
      "accessType": "EDIT",
      "entityId": "<string>",
      "entityType": "ADMIN"
    }
  ],
  "archivable": true,
  "archived": true,
  "calculated": true,
  "calculationFormula": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdByUserId": "<string>",
  "currencyPropertyName": "<string>",
  "dataEntryInstructions": "<string>",
  "dataSensitivity": "HIGH",
  "dateDisplayFormat": "ABSOLUTE",
  "defaultValue": "<string>",
  "description": "<string>",
  "formField": true,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": true,
  "label": "<string>",
  "numberDisplayFormat": "CURRENCY",
  "optionColors": [
    {
      "color": "BLACK",
      "optionName": "<string>"
    }
  ],
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "optionsSource": "CALL_DISPOSITION",
  "readOnlyDefinition": true,
  "readOnlyOptions": true,
  "readOnlyValue": true,
  "rollupConfig": {
    "associatedRecordProperty": "<string>",
    "associatedRecordType": "<string>",
    "associationSpec": {
      "category": "HUBSPOT_DEFINED",
      "typeId": 123
    },
    "rollupType": "AVG",
    "conditionalFormula": "<string>"
  },
  "sensitiveDataCategories": [
    "<string>"
  ],
  "syncConfig": {
    "associatedRecordProperty": "<string>",
    "associatedRecordType": "<string>",
    "associationSpec": {
      "category": "HUBSPOT_DEFINED",
      "typeId": 123
    },
    "syncPreference": "FIRST_CREATED"
  },
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedByUserId": "<string>",
  "validationRules": [
    {
      "ruleArguments": [
        "<string>"
      ],
      "ruleType": "AFTER_DATETIME_DURATION",
      "shouldApplyNormalization": true
    }
  ]
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

POST

crm

schemas

2027-03-beta

objects

{objectTypeId}

properties

Create property

curl --request POST \
  --url https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessAllowlist": [
    {
      "entityId": "<string>"
    }
  ],
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "sensitiveDataCategories": [
    "<string>"
  ],
  "validationRules": [
    {
      "ruleArguments": [
        "<string>"
      ],
      "shouldApplyNormalization": true
    }
  ],
  "calculationFormula": "<string>",
  "currencyPropertyName": "<string>",
  "dataEntryInstructions": "<string>",
  "defaultValue": "<string>",
  "description": "<string>",
  "formField": true,
  "hasUniqueValue": true
}
'

import requests

url = "https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties"

payload = {
    "accessAllowlist": [{ "entityId": "<string>" }],
    "groupName": "<string>",
    "label": "<string>",
    "name": "<string>",
    "options": [
        {
            "description": "<string>",
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>"
        }
    ],
    "sensitiveDataCategories": ["<string>"],
    "validationRules": [
        {
            "ruleArguments": ["<string>"],
            "shouldApplyNormalization": True
        }
    ],
    "calculationFormula": "<string>",
    "currencyPropertyName": "<string>",
    "dataEntryInstructions": "<string>",
    "defaultValue": "<string>",
    "description": "<string>",
    "formField": True,
    "hasUniqueValue": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessAllowlist: [{entityId: '<string>'}],
    groupName: '<string>',
    label: '<string>',
    name: '<string>',
    options: [
      {
        description: '<string>',
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>'
      }
    ],
    sensitiveDataCategories: ['<string>'],
    validationRules: [{ruleArguments: ['<string>'], shouldApplyNormalization: true}],
    calculationFormula: '<string>',
    currencyPropertyName: '<string>',
    dataEntryInstructions: '<string>',
    defaultValue: '<string>',
    description: '<string>',
    formField: true,
    hasUniqueValue: true
  })
};

fetch('https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties', 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.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties",
  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([
    'accessAllowlist' => [
        [
                'entityId' => '<string>'
        ]
    ],
    'groupName' => '<string>',
    'label' => '<string>',
    'name' => '<string>',
    'options' => [
        [
                'description' => '<string>',
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>'
        ]
    ],
    'sensitiveDataCategories' => [
        '<string>'
    ],
    'validationRules' => [
        [
                'ruleArguments' => [
                                '<string>'
                ],
                'shouldApplyNormalization' => true
        ]
    ],
    'calculationFormula' => '<string>',
    'currencyPropertyName' => '<string>',
    'dataEntryInstructions' => '<string>',
    'defaultValue' => '<string>',
    'description' => '<string>',
    'formField' => true,
    'hasUniqueValue' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties"

	payload := strings.NewReader("{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"description\": \"<string>\",\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sensitiveDataCategories\": [\n    \"<string>\"\n  ],\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ],\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"dataEntryInstructions\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"description\": \"<string>\",\n  \"formField\": true,\n  \"hasUniqueValue\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"description\": \"<string>\",\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sensitiveDataCategories\": [\n    \"<string>\"\n  ],\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ],\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"dataEntryInstructions\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"description\": \"<string>\",\n  \"formField\": true,\n  \"hasUniqueValue\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"description\": \"<string>\",\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sensitiveDataCategories\": [\n    \"<string>\"\n  ],\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ],\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"dataEntryInstructions\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"description\": \"<string>\",\n  \"formField\": true,\n  \"hasUniqueValue\": true\n}"

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

{
  "category": "HUBSPOT_DEFINED",
  "fieldType": "BOOLEANCHECKBOX",
  "name": "<string>",
  "type": "BOOL",
  "accessAllowlist": [
    {
      "accessType": "EDIT",
      "entityId": "<string>",
      "entityType": "ADMIN"
    }
  ],
  "archivable": true,
  "archived": true,
  "calculated": true,
  "calculationFormula": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdByUserId": "<string>",
  "currencyPropertyName": "<string>",
  "dataEntryInstructions": "<string>",
  "dataSensitivity": "HIGH",
  "dateDisplayFormat": "ABSOLUTE",
  "defaultValue": "<string>",
  "description": "<string>",
  "formField": true,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": true,
  "label": "<string>",
  "numberDisplayFormat": "CURRENCY",
  "optionColors": [
    {
      "color": "BLACK",
      "optionName": "<string>"
    }
  ],
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "optionsSource": "CALL_DISPOSITION",
  "readOnlyDefinition": true,
  "readOnlyOptions": true,
  "readOnlyValue": true,
  "rollupConfig": {
    "associatedRecordProperty": "<string>",
    "associatedRecordType": "<string>",
    "associationSpec": {
      "category": "HUBSPOT_DEFINED",
      "typeId": 123
    },
    "rollupType": "AVG",
    "conditionalFormula": "<string>"
  },
  "sensitiveDataCategories": [
    "<string>"
  ],
  "syncConfig": {
    "associatedRecordProperty": "<string>",
    "associatedRecordType": "<string>",
    "associationSpec": {
      "category": "HUBSPOT_DEFINED",
      "typeId": 123
    },
    "syncPreference": "FIRST_CREATED"
  },
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedByUserId": "<string>",
  "validationRules": [
    {
      "ruleArguments": [
        "<string>"
      ],
      "ruleType": "AFTER_DATETIME_DURATION",
      "shouldApplyNormalization": true
    }
  ]
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Scope requirements

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

objectTypeId

string

required

The unique identifier of the object type for which the property is being created.

Body

application/json

accessAllowlist

object[]

required

An array of access permissions for the property, each entry specifying the access type and entity details.

Show child attributes

fieldType

enum<string>

required

The field type of the property, with valid values including 'BOOLEANCHECKBOX', 'CALCULATION_EQUATION', 'CALCULATION_READ_TIME', 'CALCULATION_ROLLUP', 'CALCULATION_SCORE', 'CHECKBOX', 'DATE', 'EMAIL', 'FILE', 'HTML', 'NUMBER', 'PHONE_NUMBER', 'RADIO', 'SELECT', 'TEXT', 'TEXTAREA', 'UNKNOWN', and 'URL'.

Available options:

BOOLEANCHECKBOX,

CALCULATION_EQUATION,

CALCULATION_READ_TIME,

CALCULATION_ROLLUP,

CALCULATION_SCORE,

CHECKBOX,

DATE,

EMAIL,

FILE,

HTML,

NUMBER,

PHONE_NUMBER,

RADIO,

SELECT,

TEXT,

TEXTAREA,

UNKNOWN,

URL

groupName

string

required

The name of the group to which the property belongs, represented as a string.

label

string

required

A human-readable label for the property, represented as a string.

name

string

required

The unique name of the property, represented as a string.

options

object[]

required

An array of options available for the property, each option containing a label, value, and other attributes.

Show child attributes

sensitiveDataCategories

string[]

required

type

enum<string>

required

The data type of the property, with valid values including 'BOOL', 'CURRENCY_NUMBER', 'DATE', 'DATETIME', 'ENUMERATION', 'JSON', 'NUMBER', 'OBJECT_COORDINATES', 'PHONE_NUMBER', 'STRING', and 'TIME_RANGE'.

Available options:

BOOL,

CURRENCY_NUMBER,

DATE,

DATETIME,

ENUMERATION,

JSON,

NUMBER,

OBJECT_COORDINATES,

PHONE_NUMBER,

STRING,

TIME_RANGE

validationRules

object[]

required

An array of validation rules applied to the property, each specifying the rule type and arguments.

Show child attributes

calculationFormula

string

A formula used for calculating the property's value, represented as a string.

currencyPropertyName

string

dataEntryInstructions

string

Instructions for data entry related to the property, represented as a string.

dataSensitivity

enum<string>

The sensitivity level of the data, with valid values including 'NONE', 'STANDARD', and 'HIGH'.

Available options:

HIGH,

NONE,

STANDARD

dateDisplayFormat

enum<string>

Available options:

ABSOLUTE,

ABSOLUTE_WITH_RELATIVE,

TIME_SINCE,

TIME_UNTIL

defaultValue

string

The default value for the property, represented as a string.

description

string

A description of the property, represented as a string.

formField

boolean

A boolean indicating whether the property is a form field.

hasUniqueValue

boolean

A boolean indicating whether the property must have a unique value.

numberDisplayFormat

enum<string>

Available options:

CURRENCY,

DURATION,

FORMATTED,

PERCENTAGE,

PROBABILITY,

UNFORMATTED

optionDecorators

object

Show child attributes

rollupConfig

object

Show child attributes

syncConfig

object

Show child attributes

Response

successful operation

Account & Settings

Automation

CMS

CRM

Marketing

Meetings

Querying data

Reporting

Revenue

Create property

Authorizations

Path Parameters

Body

Response