Create property

curl --request POST \
  --url 'https://api.hubapi.com/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "calculationFormula": "<string>",
  "currencyPropertyName": "<string>",
  "description": "<string>",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": true,
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "referencedObjectType": "<string>",
  "showCurrencySymbol": true
}
'

import requests

url = "https://api.hubapi.com/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey="

payload = {
    "groupName": "<string>",
    "label": "<string>",
    "name": "<string>",
    "calculationFormula": "<string>",
    "currencyPropertyName": "<string>",
    "description": "<string>",
    "displayOrder": 123,
    "externalOptions": True,
    "formField": True,
    "hasUniqueValue": True,
    "hidden": True,
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ],
    "referencedObjectType": "<string>",
    "showCurrencySymbol": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    groupName: '<string>',
    label: '<string>',
    name: '<string>',
    calculationFormula: '<string>',
    currencyPropertyName: '<string>',
    description: '<string>',
    displayOrder: 123,
    externalOptions: true,
    formField: true,
    hasUniqueValue: true,
    hidden: true,
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ],
    referencedObjectType: '<string>',
    showCurrencySymbol: true
  })
};

fetch('https://api.hubapi.com/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=', 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/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=",
  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([
    'groupName' => '<string>',
    'label' => '<string>',
    'name' => '<string>',
    'calculationFormula' => '<string>',
    'currencyPropertyName' => '<string>',
    'description' => '<string>',
    'displayOrder' => 123,
    'externalOptions' => true,
    'formField' => true,
    'hasUniqueValue' => true,
    'hidden' => true,
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ],
    'referencedObjectType' => '<string>',
    'showCurrencySymbol' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "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/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey="

	payload := strings.NewReader("{\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"externalOptions\": true,\n  \"formField\": true,\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"referencedObjectType\": \"<string>\",\n  \"showCurrencySymbol\": true\n}")

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

	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/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=")
  .header("Content-Type", "application/json")
  .body("{\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"externalOptions\": true,\n  \"formField\": true,\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"referencedObjectType\": \"<string>\",\n  \"showCurrencySymbol\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"externalOptions\": true,\n  \"formField\": true,\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"referencedObjectType\": \"<string>\",\n  \"showCurrencySymbol\": true\n}"

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

{
  "allowedObjectTypes": [
    {
      "innerId": 123,
      "metaTypeId": 123
    }
  ],
  "calculated": true,
  "canArchive": true,
  "canRestore": true,
  "createdAt": 123,
  "createdUserId": 123,
  "currencyPropertyName": "<string>",
  "dataSensitivity": "high",
  "dateDisplayHint": "absolute",
  "deleted": true,
  "description": "<string>",
  "displayMode": "all_unique_versions",
  "displayOrder": 123,
  "enforceMultivalueUniqueness": true,
  "externalOptions": true,
  "externalOptionsReferenceType": "<string>",
  "favorited": true,
  "favoritedOrder": 123,
  "fieldType": "<string>",
  "formField": true,
  "fromUserId": 123,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "isCustomizedDefault": true,
  "isMultiValued": true,
  "isPartial": true,
  "label": "<string>",
  "mutableDefinitionNotDeletable": true,
  "name": "<string>",
  "numberDisplayHint": "currency",
  "optionSortStrategy": "ALPHABETICAL",
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "doubleData": 123,
      "hidden": true,
      "label": "<string>",
      "readOnly": true,
      "value": "<string>"
    }
  ],
  "optionsAreMutable": true,
  "owningAppId": 123,
  "portalId": 123,
  "readOnlyDefinition": true,
  "readOnlyValue": true,
  "referencedObjectType": "ABANDONED_CART",
  "searchTextAnalysisMode": "NONE",
  "searchableInGlobalSearch": true,
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "type": "bool",
  "updatedAt": 123
}

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

media-bridge

2026-09

{appId}

properties

{objectType}

Create property

curl --request POST \
  --url 'https://api.hubapi.com/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "calculationFormula": "<string>",
  "currencyPropertyName": "<string>",
  "description": "<string>",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": true,
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "referencedObjectType": "<string>",
  "showCurrencySymbol": true
}
'

import requests

url = "https://api.hubapi.com/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey="

payload = {
    "groupName": "<string>",
    "label": "<string>",
    "name": "<string>",
    "calculationFormula": "<string>",
    "currencyPropertyName": "<string>",
    "description": "<string>",
    "displayOrder": 123,
    "externalOptions": True,
    "formField": True,
    "hasUniqueValue": True,
    "hidden": True,
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ],
    "referencedObjectType": "<string>",
    "showCurrencySymbol": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    groupName: '<string>',
    label: '<string>',
    name: '<string>',
    calculationFormula: '<string>',
    currencyPropertyName: '<string>',
    description: '<string>',
    displayOrder: 123,
    externalOptions: true,
    formField: true,
    hasUniqueValue: true,
    hidden: true,
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ],
    referencedObjectType: '<string>',
    showCurrencySymbol: true
  })
};

fetch('https://api.hubapi.com/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=', 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/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=",
  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([
    'groupName' => '<string>',
    'label' => '<string>',
    'name' => '<string>',
    'calculationFormula' => '<string>',
    'currencyPropertyName' => '<string>',
    'description' => '<string>',
    'displayOrder' => 123,
    'externalOptions' => true,
    'formField' => true,
    'hasUniqueValue' => true,
    'hidden' => true,
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ],
    'referencedObjectType' => '<string>',
    'showCurrencySymbol' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "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/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey="

	payload := strings.NewReader("{\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"externalOptions\": true,\n  \"formField\": true,\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"referencedObjectType\": \"<string>\",\n  \"showCurrencySymbol\": true\n}")

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

	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/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=")
  .header("Content-Type", "application/json")
  .body("{\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"externalOptions\": true,\n  \"formField\": true,\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"referencedObjectType\": \"<string>\",\n  \"showCurrencySymbol\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/media-bridge/2026-09/{appId}/properties/{objectType}?hapikey=")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"groupName\": \"<string>\",\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"externalOptions\": true,\n  \"formField\": true,\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"referencedObjectType\": \"<string>\",\n  \"showCurrencySymbol\": true\n}"

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

{
  "allowedObjectTypes": [
    {
      "innerId": 123,
      "metaTypeId": 123
    }
  ],
  "calculated": true,
  "canArchive": true,
  "canRestore": true,
  "createdAt": 123,
  "createdUserId": 123,
  "currencyPropertyName": "<string>",
  "dataSensitivity": "high",
  "dateDisplayHint": "absolute",
  "deleted": true,
  "description": "<string>",
  "displayMode": "all_unique_versions",
  "displayOrder": 123,
  "enforceMultivalueUniqueness": true,
  "externalOptions": true,
  "externalOptionsReferenceType": "<string>",
  "favorited": true,
  "favoritedOrder": 123,
  "fieldType": "<string>",
  "formField": true,
  "fromUserId": 123,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "isCustomizedDefault": true,
  "isMultiValued": true,
  "isPartial": true,
  "label": "<string>",
  "mutableDefinitionNotDeletable": true,
  "name": "<string>",
  "numberDisplayHint": "currency",
  "optionSortStrategy": "ALPHABETICAL",
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "doubleData": 123,
      "hidden": true,
      "label": "<string>",
      "readOnly": true,
      "value": "<string>"
    }
  ],
  "optionsAreMutable": true,
  "owningAppId": 123,
  "portalId": 123,
  "readOnlyDefinition": true,
  "readOnlyValue": true,
  "referencedObjectType": "ABANDONED_CART",
  "searchTextAnalysisMode": "NONE",
  "searchableInGlobalSearch": true,
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "type": "bool",
  "updatedAt": 123
}

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

Required Scopes

Authorizations

hapikey

string

query

required

Path Parameters

appId

integer<int32>

required

The unique identifier of the app in which the property will be created.

objectType

string

required

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

Body

application/json

fieldType

enum<string>

required

A string indicating the field type for the property, such as 'booleancheckbox', 'calculation_equation', 'checkbox', 'date', 'file', 'html', 'number', 'phonenumber', 'radio', 'select', 'text', or 'textarea'.

Available options:

booleancheckbox,

calculation_equation,

checkbox,

date,

file,

html,

number,

phonenumber,

radio,

select,

text,

textarea

groupName

string

required

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

label

string

required

A string representing the display label for the property, used in user interfaces.

name

string

required

The unique name of the property. It is a string that identifies the property within the object type.

type

enum<string>

required

The data type of the property, which can be one of 'bool', 'date', 'datetime', 'enumeration', 'number', 'phone_number', or 'string'.

Available options:

bool,

date,

datetime,

enumeration,

number,

phone_number,

string

calculationFormula

string

A string representing the formula used to calculate the property's value, applicable for calculated properties.

currencyPropertyName

string

A string that specifies the name of the property used to determine the currency for currency-type properties.

dataSensitivity

enum<string>

A string indicating the sensitivity level of the data, such as 'PII' (Personally Identifiable Information).

Available options:

highly_sensitive,

non_sensitive,

sensitive

description

string

A string providing a description of the property, explaining its purpose or usage.

displayOrder

integer<int32>

An integer that determines the order in which the property is displayed relative to other properties.

externalOptions

boolean

A boolean that specifies whether the property options are managed externally.

formField

boolean

A boolean indicating whether the property is available for use in forms.

hasUniqueValue

boolean

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

hidden

boolean

A boolean that specifies whether the property is hidden from user interfaces.

numberDisplayHint

enum<string>

A string that provides a hint for displaying number properties, such as 'unformatted', 'formatted', 'currency', 'percentage', 'duration', or 'probability'.

Available options:

currency,

duration,

formatted,

percentage,

probability,

unformatted

options

object[]

An array of OptionInput objects, specifying the options available for properties of type 'enumeration'.

Show child attributes

referencedObjectType

string

A string that denotes the object type referenced by the property, if applicable.

showCurrencySymbol

boolean

A boolean indicating whether to display a currency symbol for currency-type properties.

textDisplayHint

enum<string>

A string that provides a hint for displaying text properties, such as 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', or 'postal_code'.

Available options:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

Response

successful operation

A HubSpot property

allowedObjectTypes

object[]

required

An array of strings representing the object types that are allowed for this property.

Show child attributes

calculated

boolean

required

A boolean indicating if the property is calculated.

canArchive

boolean

required

A boolean indicating if the property can be archived.

canRestore

boolean

required

A boolean indicating if the property can be restored.

createdAt

integer<int64>

required

A string representing the date and time when the property was created, in ISO 8601 format.

createdUserId

integer<int64>

required

A string representing the user ID who created the property.

currencyPropertyName

string

required

A string representing the name of the currency property associated with this property.

dataSensitivity

enum<string>

required

A string indicating the sensitivity level of the data.

Available options:

high,

none,

standard

dateDisplayHint

enum<string>

required

A string providing a hint for displaying dates.

Available options:

absolute,

absolute_with_relative,

time_since,

time_until

deleted

boolean

required

A boolean indicating if the property has been deleted.

description

string

required

A string providing a description of the property.

displayMode

enum<string>

required

A string indicating the display mode of the property.

Available options:

all_unique_versions,

current_value

displayOrder

integer<int32>

required

An integer specifying the order in which the property is displayed.

enforceMultivalueUniqueness

boolean

required

A boolean indicating if uniqueness is enforced for multivalue properties.

externalOptions

boolean

required

A boolean indicating if the property has external options.

externalOptionsReferenceType

string

required

A string indicating the reference type for external options.

favorited

boolean

required

A boolean indicating if the property is marked as a favorite.

favoritedOrder

integer<int32>

required

An integer specifying the order of the property among favorites.

fieldType

string

required

A string indicating the field type of the property, such as 'booleancheckbox', 'calculation_equation', 'checkbox', 'date', 'file', 'html', 'number', 'phonenumber', 'radio', 'select', 'text', or 'textarea'.

formField

boolean

required

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

fromUserId

integer<int64>

required

A string representing the user ID from which the property originates.

groupName

string

required

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

hasUniqueValue

boolean

required

A boolean indicating if the property has a unique value.

hidden

boolean

required

A boolean indicating whether the property is hidden.

Example:

false

hubspotDefined

boolean

required

A boolean indicating if the property is defined by HubSpot.

isCustomizedDefault

boolean

required

A boolean indicating if the property is a customized default.

isMultiValued

boolean

required

A boolean indicating if the property can have multiple values.

isPartial

boolean

required

A boolean indicating if the property is partial.

label

string

required

A string representing the label of the property, used for display purposes.

mutableDefinitionNotDeletable

boolean

required

A boolean indicating if the property definition is mutable but not deletable.

name

string

required

A string representing the name of the property.

numberDisplayHint

enum<string>

required

A string providing a hint for displaying numbers, with options like 'unformatted', 'formatted', 'currency', 'percentage', 'duration', or 'probability'.

Available options:

currency,

duration,

formatted,

percentage,

probability,

unformatted

optionSortStrategy

enum<string>

required

A string indicating the strategy used to sort options.

Available options:

ALPHABETICAL,

DISPLAY_ORDER

options

object[]

required

An array of options available for the property, applicable if the property type supports options.

Show child attributes

optionsAreMutable

boolean

required

A boolean indicating if the options for the property are mutable.

owningAppId

integer<int64>

required

An integer representing the ID of the app that owns the property.

portalId

integer<int64>

required

An integer representing the unique identifier for the portal.

readOnlyDefinition

boolean

required

A boolean indicating if the property's definition is read-only.

readOnlyValue

boolean

required

A boolean indicating if the property's value is read-only.

referencedObjectType

enum<string>

required

A string indicating the type of object referenced by the property.

Available options:

ABANDONED_CART,

ACCEPTANCE_TEST,

AD,

AD_ACCOUNT,

AD_CAMPAIGN,

AD_GROUP,

AI_FORECAST,

ALL_PAGES,

APPROVAL,

APPROVAL_STEP,

ATTRIBUTION,

AUDIENCE,

AUTOMATION_JOURNEY,

AUTOMATION_PLATFORM_FLOW,

AUTOMATION_PLATFORM_FLOW_ACTION,

BET_ALERT,

BET_DELIVERABLE_SERVICE,

BLOG_LISTING_PAGE,

BLOG_POST,

CALL,

CAMPAIGN,

CAMPAIGN_BUDGET_ITEM,

CAMPAIGN_SPEND_ITEM,

CAMPAIGN_STEP,

CAMPAIGN_TEMPLATE,

CAMPAIGN_TEMPLATE_STEP,

CART,

CASE_STUDY,

CHATFLOW,

CLIP,

CMS_URL,

COMBO_EVENT_CONFIGURATION,

COMMERCE_PAYMENT,

COMMUNICATION,

COMPANY,

CONTACT,

CONTACT_CREATE_ATTRIBUTION,

CONTENT,

CONTENT_AUDIT,

CONTENT_AUDIT_PAGE,

CONVERSATION,

CONVERSATION_INBOX,

CONVERSATION_SESSION,

CRM_OBJECTS_DUMMY_TYPE,

CRM_PIPELINES_DUMMY_TYPE,

CTA,

CTA_VARIANT,

DATA_PRIVACY_CONSENT,

DATA_SYNC_STATE,

DEAL,

DEAL_CREATE_ATTRIBUTION,

DEAL_REGISTRATION,

DEAL_SPLIT,

DISCOUNT,

DISCOUNT_CODE,

DISCOUNT_TEMPLATE,

EMAIL,

ENGAGEMENT,

EXPORT,

EXTERNAL_WEB_URL,

FEE,

FEEDBACK_SUBMISSION,

FEEDBACK_SURVEY,

FILE_MANAGER_FILE,

FILE_MANAGER_FOLDER,

FOLDER,

FORECAST,

FORM,

FORM_SUBMISSION_INBOUNDDB,

GOAL_TARGET,

GOAL_TARGET_GROUP,

GOAL_TEMPLATE,

GSC_PROPERTY,

HUB,

IMPORT,

INVOICE,

KEYWORD,

KNOWLEDGE_ARTICLE,

LANDING_PAGE,

LEAD,

LINE_ITEM,

MARKETING_CALENDAR,

MARKETING_CAMPAIGN_UTM,

MARKETING_EMAIL,

MARKETING_EVENT,

MARKETING_EVENT_ATTENDANCE,

MARKETING_SMS,

MEDIA_BRIDGE,

MEETING_EVENT,

MIC,

NOTE,

OBJECT_LIST,

ORDER,

OWNER,

PARTNER_ACCOUNT,

PARTNER_CLIENT,

PARTNER_CLIENT_REVENUE,

PARTNER_SERVICE,

PAYMENT_LINK,

PAYMENT_SCHEDULE,

PAYMENT_SCHEDULE_INSTALLMENT,

PERMISSIONS_TESTING,

PLAYBOOK,

PLAYBOOK_QUESTION,

PLAYBOOK_SUBMISSION,

PLAYBOOK_SUBMISSION_ANSWER,

PLAYLIST,

PLAYLIST_FOLDER,

PODCAST_EPISODE,

PORTAL,

PORTAL_OBJECT_SYNC_MESSAGE,

POSTAL_MAIL,

PRIVACY_SCANNER_COOKIE,

PRODUCT,

PRODUCT_OR_FOLDER,

PROPERTY_INFO,

PROSPECTING_AGENT_CONTACT_ASSIGNMENT,

PUBLISHING_TASK,

QUARANTINED_SUBMISSION,

QUOTA,

QUOTE,

QUOTE_FIELD,

QUOTE_MODULE,

QUOTE_MODULE_FIELD,

QUOTE_TEMPLATE,

RESTORABLE_CRM_OBJECT,

ROSTER,

ROSTER_MEMBER,

SALES_DOCUMENT,

SALES_TASK,

SALES_WORKLOAD,

SALESFORCE_SYNC_ERROR,

SCHEDULING_PAGE,

SCHEMAS_BACKEND_TEST,

SCORE_CONFIGURATION,

SEQUENCE,

SEQUENCE_ENROLLMENT,

SEQUENCE_STEP,

SEQUENCE_STEP_ENROLLMENT,

SERVICE,

SITE_PAGE,

SNIPPET,

SOCIAL_BROADCAST,

SOCIAL_CHANNEL,

SOCIAL_POST,

SOCIAL_PROFILE,

SOX_PROTECTED_DUMMY_TYPE,

SOX_PROTECTED_TEST_TYPE,

SUBMISSION_TAG,

SUBSCRIPTION,

TASK,

TASK_TEMPLATE,

TAX,

TEMPLATE,

TICKET,

UNKNOWN,

UNSUBSCRIBE,

USER,

VIEW,

VIEW_BLOCK,

WEB_INTERACTIVE

searchTextAnalysisMode

enum<string>

required

A string indicating the mode of text analysis for search purposes.

Available options:

NONE,

NOT_ANALYZED_TEXT

searchableInGlobalSearch

boolean

required

A boolean indicating if the property is searchable in global search.

sensitiveDataCategories

string[]

required

An array of strings representing the categories of sensitive data associated with this property.

showCurrencySymbol

boolean

required

A boolean indicating if the currency symbol should be displayed for the property.

textDisplayHint

enum<string>

required

A string providing a hint for displaying text, with options like 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', or 'postal_code'.

Available options:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

type

enum<string>

required

A string indicating the type of the property, such as 'bool', 'date', 'datetime', 'enumeration', 'number', 'phone_number', or 'string'.

Available options:

bool,

currency_number,

date,

datetime,

enumeration,

json,

number,

object_coordinates,

phone_number,

string,

time_range

updatedAt

integer<int64>

required

A string representing the date and time when the property was last updated, in ISO 8601 format.

Last modified on September 9, 2026

Account & Settings

App Management

Authentication

Automation

CMS

Communication preferences

Conversations

CRM

Data studio

Events

Files

Marketing

Meetings

Revenue

Webhooks

Webhooks journal

Create property

Authorizations

Path Parameters

Body

Response