Update a property

Actualizar propiedad

curl --request PATCH \
  --url https://api.hubapi.com/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calculationFormula": "<string>",
  "currencyPropertyName": "<string>",
  "description": "<string>",
  "displayOrder": 123,
  "formField": true,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": true,
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "showCurrencySymbol": true
}
'

import requests

url = "https://api.hubapi.com/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}"

payload = {
    "calculationFormula": "<string>",
    "currencyPropertyName": "<string>",
    "description": "<string>",
    "displayOrder": 123,
    "formField": True,
    "groupName": "<string>",
    "hasUniqueValue": True,
    "hidden": True,
    "label": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ],
    "showCurrencySymbol": 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({
    calculationFormula: '<string>',
    currencyPropertyName: '<string>',
    description: '<string>',
    displayOrder: 123,
    formField: true,
    groupName: '<string>',
    hasUniqueValue: true,
    hidden: true,
    label: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ],
    showCurrencySymbol: true
  })
};

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

	payload := strings.NewReader("{\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\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/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/media-bridge/2026-03/{appId}/properties/{objectType}/{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  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\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"
  }
}

PATCH

media-bridge

2026-03

{appId}

properties

{objectType}

{propertyName}

Actualizar propiedad

curl --request PATCH \
  --url https://api.hubapi.com/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calculationFormula": "<string>",
  "currencyPropertyName": "<string>",
  "description": "<string>",
  "displayOrder": 123,
  "formField": true,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": true,
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "showCurrencySymbol": true
}
'

import requests

url = "https://api.hubapi.com/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}"

payload = {
    "calculationFormula": "<string>",
    "currencyPropertyName": "<string>",
    "description": "<string>",
    "displayOrder": 123,
    "formField": True,
    "groupName": "<string>",
    "hasUniqueValue": True,
    "hidden": True,
    "label": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ],
    "showCurrencySymbol": 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({
    calculationFormula: '<string>',
    currencyPropertyName: '<string>',
    description: '<string>',
    displayOrder: 123,
    formField: true,
    groupName: '<string>',
    hasUniqueValue: true,
    hidden: true,
    label: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ],
    showCurrencySymbol: true
  })
};

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

	payload := strings.NewReader("{\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\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/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/media-bridge/2026-03/{appId}/properties/{objectType}/{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  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hasUniqueValue\": true,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\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

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de ruta

appId

integer<int32>

requerido

objectType

string

requerido

propertyName

string

requerido

Cuerpo

application/json

calculationFormula

string

Una cadena que representa la fórmula utilizada para calcular el valor de la propiedad.

currencyPropertyName

string

Una cadena que representa el nombre de la propiedad de divisa asociada a esta propiedad.

description

string

Una cadena que proporciona una descripción de la propiedad.

displayOrder

integer<int32>

Un número entero que indica el orden de visualización de la propiedad.

fieldType

enum<string>

Una cadena que especifica el tipo de campo de la propiedad. Los valores válidos son "booleancheckbox", "calculation_equation", "checkbox", "date", "file", "html", "number", "phonenumber", "radio", "select", "text" y "textarea".

Opciones disponibles:

booleancheckbox,

calculation_equation,

checkbox,

date,

file,

html,

number,

phonenumber,

radio,

select,

text,

textarea

formField

boolean

Un booleano que indica si la propiedad es un campo de formulario.

groupName

string

Una cadena que representa el nombre del grupo al que pertenece la propiedad.

hasUniqueValue

boolean

Un booleano que indica si la propiedad tiene un valor único.

hidden

boolean

Un booleano que indica si la propiedad está oculta.

label

string

Una cadena que representa la etiqueta de la propiedad.

numberDisplayHint

enum<string>

Una cadena que proporciona una sugerencia sobre cómo mostrar los números. Los valores válidos son "unformatted", "formatted", "currency", "percentage", "duration" y "probability".

Opciones disponibles:

currency,

duration,

formatted,

percentage,

probability,

unformatted

options

object[]

Una matriz de objetos OptionInput que representan las opciones disponibles para la propiedad.

Show child attributes

showCurrencySymbol

boolean

Un booleano que indica si se debe mostrar el símbolo de divisa de la propiedad.

textDisplayHint

enum<string>

Una cadena que proporciona una sugerencia sobre cómo mostrar el texto. Los valores válidos son "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" y "postal_code".

Opciones disponibles:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

type

enum<string>

Una cadena que indica el tipo de datos de la propiedad. Los valores válidos son "bool", "date", "datetime", "enumeration", "number", "phone_number" y "string".

Opciones disponibles:

bool,

date,

datetime,

enumeration,

number,

phone_number,

string

Respuesta

successful operation

A HubSpot property

allowedObjectTypes

object[]

requerido

Un conjunto de cadenas que representan los tipos de objetos permitidos para esta propiedad.

Show child attributes

calculated

boolean

requerido

Un booleano que indica si la propiedad es calculada.

canArchive

boolean

requerido

Un valor booleano que indica si la propiedad se puede archivar.

canRestore

boolean

requerido

Un booleano que indica si la propiedad se puede restaurar.

createdAt

integer<int64>

requerido

Una cadena que representa la fecha y hora en que se creó la propiedad, en formato ISO 8601.

createdUserId

integer<int64>

requerido

Una cadena que representa el ID del usuario que creó la propiedad.

currencyPropertyName

string

requerido

Una cadena que representa el nombre de la propiedad de divisa asociada a esta propiedad.

dataSensitivity

enum<string>

requerido

Una cadena que indica el nivel de sensibilidad de los datos.

Opciones disponibles:

high,

none,

standard

dateDisplayHint

enum<string>

requerido

Una cadena que da una sugerencia para mostrar fechas.

Opciones disponibles:

absolute,

absolute_with_relative,

time_since,

time_until

deleted

boolean

requerido

Un booleano que indica si la propiedad fue eliminada.

description

string

requerido

Una cadena que proporciona una descripción de la propiedad.

displayMode

enum<string>

requerido

Una cadena que indica el modo de visualización de la propiedad.

Opciones disponibles:

all_unique_versions,

current_value

displayOrder

integer<int32>

requerido

Un número entero que especifica el orden en que se muestra la propiedad.

enforceMultivalueUniqueness

boolean

requerido

Un booleano que indica si se aplica la unicidad para las propiedades de valores múltiples.

externalOptions

boolean

requerido

Un booleano que indica si la propiedad tiene opciones externas.

externalOptionsReferenceType

string

requerido

Una cadena que indica el tipo de referencia para las opciones externas.

favorited

boolean

requerido

Un booleano que indica si la propiedad está marcada como favorita.

favoritedOrder

integer<int32>

requerido

Un número entero que especifica el orden de la propiedad entre las favoritas.

fieldType

string

requerido

Una cadena que indica el tipo de campo de la propiedad, como "booleancheckbox", "calculation_equation", "checkbox", "date", "file", "html", "number", "phonenumber", "radio", "select", "text" o "textarea".

formField

boolean

requerido

Un booleano que indica si la propiedad se usa como campo de formulario.

fromUserId

integer<int64>

requerido

Una cadena que representa el ID de usuario del que procede la propiedad.

groupName

string

requerido

Una cadena que representa el nombre del grupo al que pertenece la propiedad.

hasUniqueValue

boolean

requerido

Un booleano que indica si la propiedad tiene un valor único.

hidden

boolean

requerido

Un booleano que indica si la propiedad está oculta.

Ejemplo:

false

hubspotDefined

boolean

requerido

Un booleano que indica si la propiedad está definida por HubSpot.

isCustomizedDefault

boolean

requerido

Un booleano que indica si la propiedad es un valor predeterminado personalizado.

isMultiValued

boolean

requerido

Un booleano que indica si la propiedad puede tener varios valores.

isPartial

boolean

requerido

Un booleano que indica si la propiedad es parcial.

label

string

requerido

Una cadena que representa la etiqueta de la propiedad y se usa para fines de visualización.

mutableDefinitionNotDeletable

boolean

requerido

Un booleano que indica si la propiedad puede modificarse pero no eliminarse.

name

string

requerido

Una cadena que representa el nombre de la propiedad.

numberDisplayHint

enum<string>

requerido

Una cadena que proporciona una sugerencia para mostrar números, con opciones como "unformatted", "formatted", "currency", "percentage", "duration" o "probability".

Opciones disponibles:

currency,

duration,

formatted,

percentage,

probability,

unformatted

optionSortStrategy

enum<string>

requerido

Una cadena que indica la estrategia utilizada para ordenar las opciones.

Opciones disponibles:

ALPHABETICAL,

DISPLAY_ORDER

options

object[]

requerido

Opciones disponibles para la propiedad, aplicables si el tipo de propiedad admite opciones.

Show child attributes

optionsAreMutable

boolean

requerido

Un booleano que indica si las opciones de la propiedad se pueden modificar.

owningAppId

integer<int64>

requerido

Un número entero que representa el ID de la aplicación que posee la propiedad.

portalId

integer<int64>

requerido

Un número entero que representa el identificador único del portal.

readOnlyDefinition

boolean

requerido

Un booleano que indica si la definición de la propiedad es de solo lectura.

readOnlyValue

boolean

requerido

Un booleano que indica si el valor de la propiedad es de solo lectura.

referencedObjectType

enum<string>

requerido

Una cadena que indica el tipo de objeto al que hace referencia la propiedad.

Opciones disponibles:

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>

requerido

Una cadena que indica el modo de análisis de texto para fines de búsqueda.

Opciones disponibles:

NONE,

NOT_ANALYZED_TEXT

searchableInGlobalSearch

boolean

requerido

Un booleano que indica si la propiedad se puede buscar en la búsqueda global.

sensitiveDataCategories

string[]

requerido

Un conjunto de cadenas que representan las categorías de datos sensibles asociadas con esta propiedad.

showCurrencySymbol

boolean

requerido

Un booleano que indica si el símbolo de divisa debe mostrarse en la propiedad.

textDisplayHint

enum<string>

requerido

Una cadena que proporciona una sugerencia para mostrar texto, con opciones como "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" o "postal_code".

Opciones disponibles:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

type

enum<string>

requerido

Una cadena que indica el tipo de propiedad, como "bool", "date", "datetime", "enumeration", "number", "phone_number" o "string".

Opciones disponibles:

bool,

currency_number,

date,

datetime,

enumeration,

json,

number,

object_coordinates,

phone_number,

string,

time_range

updatedAt

integer<int64>

requerido

Una cadena que representa la fecha y hora de la última actualización de la propiedad, en formato ISO 8601.

Última modificación el 3 de abril de 2026

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Eventos

Archivos

Marketing

Programador

Webhooks

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta