Pular para o conteúdo principal
POST
/
media-bridge
/
v1
/
{appId}
/
properties
/
{objectType}
Criar uma nova propriedade
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
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

Autorizações

hapikey
string
query
obrigatório

Parâmetros de caminho

appId
integer<int32>
obrigatório

O appId do aplicativo Media Bridge. É possível ter vários aplicativos na sua conta de desenvolvedor que usam a Media Bridge.

objectType
string
obrigatório

O tipo de objeto para o qual a nova propriedade será criada.

Corpo

application/json
fieldType
enum<string>
obrigatório
Opções disponíveis:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
groupName
string
obrigatório
label
string
obrigatório
name
string
obrigatório
type
enum<string>
obrigatório
Opções disponíveis:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string
calculationFormula
string
dataSensitivity
enum<string>
Opções disponíveis:
highly_sensitive,
non_sensitive,
sensitive
description
string
displayOrder
integer<int32>
externalOptions
boolean
formField
boolean
hasUniqueValue
boolean
hidden
boolean
options
object[]
referencedObjectType
string

Resposta

successful operation

Propriedade do HubSpot

allowedObjectTypes
object[]
obrigatório

Tipos de objetos autorizados a usar esta propriedade.

calculated
boolean
obrigatório

Se a propriedade é um campo calculado.

canArchive
boolean
obrigatório
canRestore
boolean
obrigatório
createdAt
integer<int64>
obrigatório

A data e hora em que a propriedade foi criada, no formato ISO 8601.

createdUserId
integer<int64>
obrigatório

O ID do usuário que criou a propriedade.

currencyPropertyName
string
obrigatório

O nome da propriedade de moeda relacionada.

dataSensitivity
enum<string>
obrigatório

Indica o nível de sensibilidade da propriedade, como "non_sensitive", "sensitive" ou "highly_sensitive".

Opções disponíveis:
high,
none,
standard
dateDisplayHint
enum<string>
obrigatório
Opções disponíveis:
absolute,
absolute_with_relative,
time_since,
time_until
deleted
boolean
obrigatório

Se a propriedade foi excluída.

description
string
obrigatório

Um resumo da finalidade da propriedade.

displayMode
enum<string>
obrigatório

O modo em que a propriedade é exibida. Pode ser: "current_value" ou "all_unique_versions".

Opções disponíveis:
all_unique_versions,
current_value
displayOrder
integer<int32>
obrigatório

A posição do item em relação aos outros na lista.

enforceMultivalueUniqueness
boolean
obrigatório
externalOptions
boolean
obrigatório

Aplicável apenas a propriedades do tipo enumeração. Deve ser definido como verdadeiro com um "referencedObjectType" de "PROPRIETÁRIO". Caso contrário, falso.

externalOptionsReferenceType
string
obrigatório

Quando externalOptions é verdadeiro, indica que os valores de opção da propriedade serão preenchidos de outros sistemas (por exemplo, "PROPRIETÁRIO" para a propriedade hubspot_owner_id).

favorited
boolean
obrigatório

Obsoleto. Se a propriedade está marcada como favorita.

favoritedOrder
integer<int32>
obrigatório

Obsoleto. A posição na ordem quando marcada como favorita.

fieldType
string
obrigatório

Determina como a propriedade aparecerá na interface do HubSpot ou em um formulário. Saiba mais no guia da API de propriedades.

formField
boolean
obrigatório

Se a propriedade pode aparecer em formulários.

fromUserId
integer<int64>
obrigatório

O ID do usuário que atualizou a propriedade pela última vez.

groupName
string
obrigatório

O nome do grupo ao qual a propriedade é atribuída.

hasUniqueValue
boolean
obrigatório

Se a propriedade é uma propriedade de identificador exclusivo.

hidden
boolean
obrigatório

Se a propriedade será ou não ocultada da interface do HubSpot. É recomendado definir como falso para propriedades personalizadas.

Exemplo:

false

hubspotDefined
boolean
obrigatório

Um valor booleano definido como verdadeiro para propriedades padrão do HubSpot.

isCustomizedDefault
boolean
obrigatório

Para propriedades padrão, indica se a propriedade foi personalizada. Equivalente ao campo "isCustomizedDefault".

isMultiValued
boolean
obrigatório

Se a propriedade pode conter vários valores.

isPartial
boolean
obrigatório

Para propriedades padrão, indica se a propriedade foi personalizada. Equivalente ao campo "isCustomizedDefault".

label
string
obrigatório

O rótulo de exibição da propriedade.

mutableDefinitionNotDeletable
boolean
obrigatório

Se a definição da propriedade pode ser personalizada, mas não excluída.

name
string
obrigatório

O nome interno da propriedade.

numberDisplayHint
enum<string>
obrigatório

Dica de como uma propriedade numérica é exibida e validada na interface do HubSpot. Pode ser: "sem formato", "formatado", "moeda", "porcentagem", "duração" ou "probabilidade".

Opções disponíveis:
currency,
duration,
formatted,
percentage,
probability,
unformatted
optionSortStrategy
enum<string>
obrigatório

Especifica como classificar as opções de propriedade. Pode ser "DISPLAY_ORDER" para adiar para o campo displayOrder ou "ALFABÉTICO".

Opções disponíveis:
ALPHABETICAL,
DISPLAY_ORDER
options
object[]
obrigatório

Uma lista de opções válidas para a propriedade. Este campo é obrigatório para propriedades enumeradas.

optionsAreMutable
boolean
obrigatório

Se as opções podem ser modificadas após a criação.

owningAppId
integer<int64>
obrigatório
portalId
integer<int64>
obrigatório

O ID da conta da HubSpot onde a propriedade está definida.

readOnlyDefinition
boolean
obrigatório

Se a descrição da propriedade é somente leitura.

readOnlyValue
boolean
obrigatório

Indica se o valor da propriedade é somente leitura.

referencedObjectType
enum<string>
obrigatório

Obsoleto. Em vez disso, use externalOptionsReferenceType.

Opções disponíveis:
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>
obrigatório
Opções disponíveis:
NONE,
NOT_ANALYZED_TEXT

Se a propriedade pode ser pesquisada globalmente.

sensitiveDataCategories
string[]
obrigatório

Quando sensitiveData é verdadeiro, lista o tipo de dados confidenciais contidos na propriedade (por exemplo, "HIPAA").

showCurrencySymbol
boolean
obrigatório

Se o símbolo da moeda deve ser exibido na interface do HubSpot.

textDisplayHint
enum<string>
obrigatório

Dica de como o texto é exibido e validado na interface do HubSpot. Pode ser: "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" ou "postal_code".

Opções disponíveis:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
type
enum<string>
obrigatório

O tipo de dados da propriedade, como string ou número.

Opções disponíveis:
bool,
currency_number,
date,
datetime,
enumeration,
json,
number,
object_coordinates,
phone_number,
string
updatedAt
integer<int64>
obrigatório

A data e hora em que a propriedade foi atualizada pela última vez, no formato ISO 8601.

Last modified on January 23, 2026