Crear nueva propiedad

curl --request POST \
  --url 'https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldType": "booleancheckbox",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "type": "bool",
  "calculationFormula": "<string>",
  "dataSensitivity": "highly_sensitive",
  "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>"
}
'

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

POST

media-bridge

{appId}

properties

{objectType}

Crear nueva propiedad

curl --request POST \
  --url 'https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldType": "booleancheckbox",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "type": "bool",
  "calculationFormula": "<string>",
  "dataSensitivity": "highly_sensitive",
  "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>"
}
'

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

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.

Marketing HubGratuito

Sales HubGratuito

Service HubGratuito

Content HubGratuito

Autorizaciones

hapikey

string

query

requerido

Parámetros de ruta

appId

integer<int32>

requerido

El appId de la aplicación del centro multimedia. Es posible tener varias aplicaciones en tu cuenta de desarrollador que utilicen el centro multimedia.

objectType

string

requerido

El tipo de objeto para el que se creará la nueva propiedad.

Cuerpo

application/json

fieldType

enum<string>

requerido

Opciones disponibles:

booleancheckbox,

calculation_equation,

checkbox,

date,

file,

html,

number,

phonenumber,

radio,

select,

text,

textarea

groupName

string

requerido

label

string

requerido

name

string

requerido

type

enum<string>

requerido

Opciones disponibles:

bool,

date,

datetime,

enumeration,

number,

phone_number,

string

calculationFormula

string

dataSensitivity

enum<string>

Opciones disponibles:

highly_sensitive,

non_sensitive,

sensitive

description

string

displayOrder

integer<int32>

externalOptions

boolean

formField

boolean

hasUniqueValue

boolean

hidden

boolean

options

object[]

Mostrar atributos secundarios

referencedObjectType

string

Respuesta

successful operation

A HubSpot property

allowedObjectTypes

object[]

requerido

Tipos de objeto que pueden utilizar esta propiedad.

Mostrar atributos secundarios

calculated

boolean

requerido

Si la propiedad es un campo calculado.

canArchive

boolean

requerido

canRestore

boolean

requerido

createdAt

integer<int64>

requerido

La marca de tiempo en la que se creó la propiedad, en formato ISO 8601.

createdUserId

integer<int64>

requerido

El ID del usuario que creó la propiedad.

currencyPropertyName

string

requerido

El nombre de la propiedad de divisa relacionada.

dataSensitivity

enum<string>

requerido

Indica el nivel de sensibilidad de la propiedad, como "non_sensitive", "sensitive", or "highly_sensitive".

Opciones disponibles:

high,

none,

standard

dateDisplayHint

enum<string>

requerido

Opciones disponibles:

absolute,

absolute_with_relative,

time_since,

time_until

deleted

boolean

requerido

Si la propiedad fue eliminada.

description

string

requerido

Un resumen de la finalidad de la propiedad.

displayMode

enum<string>

requerido

El modo en el que se muestra la propiedad. Puede ser: "current_value" or "all_unique_versions".

Opciones disponibles:

all_unique_versions,

current_value

displayOrder

integer<int32>

requerido

La posición del elemento en relación con otros de la lista.

enforceMultivalueUniqueness

boolean

requerido

externalOptions

boolean

requerido

Aplicable solo a propiedades de tipo de enumeración. Debe establecerse en verdadero con un "referencedObjectType" de "OWNER". De lo contrario, falso.

externalOptionsReferenceType

string

requerido

Cuando externalOptions es verdadero, indica que los valores de opción de la propiedad se rellenarán desde otros sistemas (por ejemplo, "OWNER" para la propiedad hubspot_owner_id).

favorited

boolean

requerido

Obsoleto. Si la propiedad está marcada como favorita.

favoritedOrder

integer<int32>

requerido

Obsoleto. La posición del pedido cuando se marca como favorito.

fieldType

string

requerido

Determina cómo aparecerá la propiedad en la IU de HubSpot o en un formulario. Más información en la guía de la API de propiedades.

formField

boolean

requerido

Si la propiedad puede aparecer en los formularios.

fromUserId

integer<int64>

requerido

El ID del usuario que actualizó la propiedad por última vez.

groupName

string

requerido

El nombre del grupo al que se asigna la propiedad.

hasUniqueValue

boolean

requerido

Si la propiedad es un identificador único.

hidden

boolean

requerido

Si la propiedad se ocultará o no de la IU de HubSpot. Se recomienda que esto se establezca en falso para las propiedades personalizadas.

Ejemplo:

false

hubspotDefined

boolean

requerido

Un valor booleano establecido en verdadero para las propiedades predeterminadas de HubSpot.

isCustomizedDefault

boolean

requerido

Para propiedades predeterminadas, si la propiedad ha sido personalizada. Equivale al campo "isCustomizedDefault".

isMultiValued

boolean

requerido

Si la propiedad puede contener múltiples valores.

isPartial

boolean

requerido

Para propiedades predeterminadas, si la propiedad ha sido personalizada. Equivale al campo "isCustomizedDefault".

label

string

requerido

La etiqueta de visualización de la propiedad.

mutableDefinitionNotDeletable

boolean

requerido

Si la definición de la propiedad se puede personalizar pero no eliminar.

name

string

requerido

El nombre interno de la propiedad.

numberDisplayHint

enum<string>

requerido

Sugerencia sobre cómo se muestra y valida una propiedad numérica en la IU de HubSpot. Puede ser: "unformatted", "formatted", "currency", "percentage", "duration" o "probability".

Opciones disponibles:

currency,

duration,

formatted,

percentage,

probability,

unformatted

optionSortStrategy

enum<string>

requerido

Especifica cómo ordenar las opciones de propiedades. Puede ser "DISPLAY_ORDER" para diferir al campo displayOrder, o "ALPHABETICAL".

Opciones disponibles:

ALPHABETICAL,

DISPLAY_ORDER

options

object[]

requerido

Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas.

Mostrar atributos secundarios

optionsAreMutable

boolean

requerido

Si las opciones se pueden modificar después de la creación.

owningAppId

integer<int64>

requerido

portalId

integer<int64>

requerido

El ID de la cuenta de HubSpot donde se define la propiedad.

readOnlyDefinition

boolean

requerido

Si la descripción de la propiedad es de solo lectura.

readOnlyValue

boolean

requerido

Indica si el valor de la propiedad es de solo lectura.

referencedObjectType

enum<string>

requerido

Obsoleto. Utiliza externalOptionsReferenceType en su lugar.

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

Opciones disponibles:

NONE,

NOT_ANALYZED_TEXT

searchableInGlobalSearch

boolean

requerido

Si la propiedad se puede buscar globalmente.

sensitiveDataCategories

string[]

requerido

Cuando sensitiveData es verdadero, enumera el tipo de datos sensibles contenidos en la propiedad (por ejemplo, "HIPAA").

showCurrencySymbol

boolean

requerido

Si se muestra el símbolo de la divisa en la IU de HubSpot.

textDisplayHint

enum<string>

requerido

Sugerencia sobre cómo se muestra y valida el texto en la IU de HubSpot. Puede ser: "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

El tipo de datos de la propiedad, como cadena o número.

Opciones disponibles:

bool,

currency_number,

date,

datetime,

enumeration,

json,

number,

object_coordinates,

phone_number,

string

updatedAt

integer<int64>

requerido

La marca de tiempo en la que se actualizó la propiedad, en formato ISO 8601.

Last modified on September 3, 2025

Obtener las propiedades de un tipo de objeto.

Obtener los datos de una propiedad

⌘I

Publicaciones de blog

Configuración del blog

Etiquetas de blog

HubDB

Páginas

Autores de blog

Código fuente del CMS

Auditoría de contenido

Redireccionamientos de URL

Dominios

Centro multimedia

Búsqueda en el sitio

Archivos

Crear nueva propiedad

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta