Update property

curl --request PATCH \
  --url https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessAllowlist": [
    {
      "entityId": "<string>"
    }
  ],
  "archived": true,
  "calculationFormula": {},
  "currencyPropertyName": {},
  "dataEntryInstructions": {},
  "dataSensitivity": {},
  "dateDisplayFormat": {},
  "defaultValue": {},
  "description": {},
  "formField": true,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "label": "<string>",
  "numberDisplayFormat": {},
  "optionDecorators": {},
  "options": {},
  "rollupConfig": {},
  "sensitiveDataCategories": {},
  "syncConfig": {},
  "validationRules": [
    {
      "ruleArguments": [
        "<string>"
      ],
      "shouldApplyNormalization": true
    }
  ]
}
'

import requests

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

payload = {
    "accessAllowlist": [{ "entityId": "<string>" }],
    "archived": True,
    "calculationFormula": {},
    "currencyPropertyName": {},
    "dataEntryInstructions": {},
    "dataSensitivity": {},
    "dateDisplayFormat": {},
    "defaultValue": {},
    "description": {},
    "formField": True,
    "groupName": "<string>",
    "hasUniqueValue": True,
    "label": "<string>",
    "numberDisplayFormat": {},
    "optionDecorators": {},
    "options": {},
    "rollupConfig": {},
    "sensitiveDataCategories": {},
    "syncConfig": {},
    "validationRules": [
        {
            "ruleArguments": ["<string>"],
            "shouldApplyNormalization": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessAllowlist: [{entityId: '<string>'}],
    archived: true,
    calculationFormula: {},
    currencyPropertyName: {},
    dataEntryInstructions: {},
    dataSensitivity: {},
    dateDisplayFormat: {},
    defaultValue: {},
    description: {},
    formField: true,
    groupName: '<string>',
    hasUniqueValue: true,
    label: '<string>',
    numberDisplayFormat: {},
    optionDecorators: {},
    options: {},
    rollupConfig: {},
    sensitiveDataCategories: {},
    syncConfig: {},
    validationRules: [{ruleArguments: ['<string>'], shouldApplyNormalization: true}]
  })
};

fetch('https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties/{propertyName}', 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/{propertyName}",
  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([
    'accessAllowlist' => [
        [
                'entityId' => '<string>'
        ]
    ],
    'archived' => true,
    'calculationFormula' => [
        
    ],
    'currencyPropertyName' => [
        
    ],
    'dataEntryInstructions' => [
        
    ],
    'dataSensitivity' => [
        
    ],
    'dateDisplayFormat' => [
        
    ],
    'defaultValue' => [
        
    ],
    'description' => [
        
    ],
    'formField' => true,
    'groupName' => '<string>',
    'hasUniqueValue' => true,
    'label' => '<string>',
    'numberDisplayFormat' => [
        
    ],
    'optionDecorators' => [
        
    ],
    'options' => [
        
    ],
    'rollupConfig' => [
        
    ],
    'sensitiveDataCategories' => [
        
    ],
    'syncConfig' => [
        
    ],
    'validationRules' => [
        [
                'ruleArguments' => [
                                '<string>'
                ],
                'shouldApplyNormalization' => 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/{propertyName}"

	payload := strings.NewReader("{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"archived\": true,\n  \"calculationFormula\": {},\n  \"currencyPropertyName\": {},\n  \"dataEntryInstructions\": {},\n  \"dataSensitivity\": {},\n  \"dateDisplayFormat\": {},\n  \"defaultValue\": {},\n  \"description\": {},\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"label\": \"<string>\",\n  \"numberDisplayFormat\": {},\n  \"optionDecorators\": {},\n  \"options\": {},\n  \"rollupConfig\": {},\n  \"sensitiveDataCategories\": {},\n  \"syncConfig\": {},\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"archived\": true,\n  \"calculationFormula\": {},\n  \"currencyPropertyName\": {},\n  \"dataEntryInstructions\": {},\n  \"dataSensitivity\": {},\n  \"dateDisplayFormat\": {},\n  \"defaultValue\": {},\n  \"description\": {},\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"label\": \"<string>\",\n  \"numberDisplayFormat\": {},\n  \"optionDecorators\": {},\n  \"options\": {},\n  \"rollupConfig\": {},\n  \"sensitiveDataCategories\": {},\n  \"syncConfig\": {},\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"archived\": true,\n  \"calculationFormula\": {},\n  \"currencyPropertyName\": {},\n  \"dataEntryInstructions\": {},\n  \"dataSensitivity\": {},\n  \"dateDisplayFormat\": {},\n  \"defaultValue\": {},\n  \"description\": {},\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"label\": \"<string>\",\n  \"numberDisplayFormat\": {},\n  \"optionDecorators\": {},\n  \"options\": {},\n  \"rollupConfig\": {},\n  \"sensitiveDataCategories\": {},\n  \"syncConfig\": {},\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ]\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"
  }
}

PATCH

crm

schemas

2027-03-beta

objects

{objectTypeId}

properties

{propertyName}

Update property

curl --request PATCH \
  --url https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessAllowlist": [
    {
      "entityId": "<string>"
    }
  ],
  "archived": true,
  "calculationFormula": {},
  "currencyPropertyName": {},
  "dataEntryInstructions": {},
  "dataSensitivity": {},
  "dateDisplayFormat": {},
  "defaultValue": {},
  "description": {},
  "formField": true,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "label": "<string>",
  "numberDisplayFormat": {},
  "optionDecorators": {},
  "options": {},
  "rollupConfig": {},
  "sensitiveDataCategories": {},
  "syncConfig": {},
  "validationRules": [
    {
      "ruleArguments": [
        "<string>"
      ],
      "shouldApplyNormalization": true
    }
  ]
}
'

import requests

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

payload = {
    "accessAllowlist": [{ "entityId": "<string>" }],
    "archived": True,
    "calculationFormula": {},
    "currencyPropertyName": {},
    "dataEntryInstructions": {},
    "dataSensitivity": {},
    "dateDisplayFormat": {},
    "defaultValue": {},
    "description": {},
    "formField": True,
    "groupName": "<string>",
    "hasUniqueValue": True,
    "label": "<string>",
    "numberDisplayFormat": {},
    "optionDecorators": {},
    "options": {},
    "rollupConfig": {},
    "sensitiveDataCategories": {},
    "syncConfig": {},
    "validationRules": [
        {
            "ruleArguments": ["<string>"],
            "shouldApplyNormalization": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessAllowlist: [{entityId: '<string>'}],
    archived: true,
    calculationFormula: {},
    currencyPropertyName: {},
    dataEntryInstructions: {},
    dataSensitivity: {},
    dateDisplayFormat: {},
    defaultValue: {},
    description: {},
    formField: true,
    groupName: '<string>',
    hasUniqueValue: true,
    label: '<string>',
    numberDisplayFormat: {},
    optionDecorators: {},
    options: {},
    rollupConfig: {},
    sensitiveDataCategories: {},
    syncConfig: {},
    validationRules: [{ruleArguments: ['<string>'], shouldApplyNormalization: true}]
  })
};

fetch('https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties/{propertyName}', 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/{propertyName}",
  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([
    'accessAllowlist' => [
        [
                'entityId' => '<string>'
        ]
    ],
    'archived' => true,
    'calculationFormula' => [
        
    ],
    'currencyPropertyName' => [
        
    ],
    'dataEntryInstructions' => [
        
    ],
    'dataSensitivity' => [
        
    ],
    'dateDisplayFormat' => [
        
    ],
    'defaultValue' => [
        
    ],
    'description' => [
        
    ],
    'formField' => true,
    'groupName' => '<string>',
    'hasUniqueValue' => true,
    'label' => '<string>',
    'numberDisplayFormat' => [
        
    ],
    'optionDecorators' => [
        
    ],
    'options' => [
        
    ],
    'rollupConfig' => [
        
    ],
    'sensitiveDataCategories' => [
        
    ],
    'syncConfig' => [
        
    ],
    'validationRules' => [
        [
                'ruleArguments' => [
                                '<string>'
                ],
                'shouldApplyNormalization' => 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/{propertyName}"

	payload := strings.NewReader("{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"archived\": true,\n  \"calculationFormula\": {},\n  \"currencyPropertyName\": {},\n  \"dataEntryInstructions\": {},\n  \"dataSensitivity\": {},\n  \"dateDisplayFormat\": {},\n  \"defaultValue\": {},\n  \"description\": {},\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"label\": \"<string>\",\n  \"numberDisplayFormat\": {},\n  \"optionDecorators\": {},\n  \"options\": {},\n  \"rollupConfig\": {},\n  \"sensitiveDataCategories\": {},\n  \"syncConfig\": {},\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.hubapi.com/crm/schemas/2027-03-beta/objects/{objectTypeId}/properties/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"archived\": true,\n  \"calculationFormula\": {},\n  \"currencyPropertyName\": {},\n  \"dataEntryInstructions\": {},\n  \"dataSensitivity\": {},\n  \"dateDisplayFormat\": {},\n  \"defaultValue\": {},\n  \"description\": {},\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"label\": \"<string>\",\n  \"numberDisplayFormat\": {},\n  \"optionDecorators\": {},\n  \"options\": {},\n  \"rollupConfig\": {},\n  \"sensitiveDataCategories\": {},\n  \"syncConfig\": {},\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessAllowlist\": [\n    {\n      \"entityId\": \"<string>\"\n    }\n  ],\n  \"archived\": true,\n  \"calculationFormula\": {},\n  \"currencyPropertyName\": {},\n  \"dataEntryInstructions\": {},\n  \"dataSensitivity\": {},\n  \"dateDisplayFormat\": {},\n  \"defaultValue\": {},\n  \"description\": {},\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"label\": \"<string>\",\n  \"numberDisplayFormat\": {},\n  \"optionDecorators\": {},\n  \"options\": {},\n  \"rollupConfig\": {},\n  \"sensitiveDataCategories\": {},\n  \"syncConfig\": {},\n  \"validationRules\": [\n    {\n      \"ruleArguments\": [\n        \"<string>\"\n      ],\n      \"shouldApplyNormalization\": true\n    }\n  ]\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 whose property you want to update.

propertyName

string

required

The name of the property to update.

Body

application/json

accessAllowlist

object[]

An array of PublicAccessAllowlistEntry objects that define the access permissions for the property.

Show child attributes

archived

boolean

A boolean indicating whether the property is archived.

calculationFormula

object

An object representing the calculation formula for the property. The specific properties are not detailed in the spec.

currencyPropertyName

object

dataEntryInstructions

object

An object providing instructions for data entry. The specific properties are not detailed in the spec.

dataSensitivity

object

An object representing the sensitivity level of the data. The specific properties are not detailed in the spec.

dateDisplayFormat

object

defaultValue

object

An object indicating the default value for the property. The specific properties are not detailed in the spec.

description

object

An object providing a description of the property. The specific properties are not detailed in the spec.

fieldType

enum<string>

A string specifying the field type of the property. Valid options include '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

formField

boolean

A boolean indicating whether the property is used as a form field.

groupName

string

A string representing the group name to which the property belongs.

hasUniqueValue

boolean

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

label

string

A string representing the display name of the property.

numberDisplayFormat

object

optionDecorators

object

An object representing the option decorators for the property. The specific properties are not detailed in the spec.

options

object

An object representing the available options for the property. The specific properties are not detailed in the spec.

rollupConfig

object

An object representing the rollup configuration for the property. The specific properties are not detailed in the spec.

sensitiveDataCategories

object

syncConfig

object

An object representing the synchronization configuration for the property. The specific properties are not detailed in the spec.

type

enum<string>

A string indicating the data type of the property. Valid values include '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[]

An array of ValidationRule objects that define the validation rules for the property.

Show child attributes

Response

successful operation

Account & Settings

Automation

CMS

CRM

Marketing

Meetings

Querying data

Reporting

Revenue

Update property

Authorizations

Path Parameters

Body

Response