Zum Hauptinhalt springen
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} \
  --header 'Content-Type: application/json' \
  --data '{
  "hidden": true,
  "displayOrder": 123,
  "description": "<string>",
  "label": "<string>",
  "type": "bool",
  "formField": true,
  "dataSensitivity": "non_sensitive",
  "groupName": "<string>",
  "referencedObjectType": "<string>",
  "name": "<string>",
  "options": [
    {
      "hidden": true,
      "displayOrder": 123,
      "description": "<string>",
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "calculationFormula": "<string>",
  "hasUniqueValue": true,
  "fieldType": "booleancheckbox",
  "externalOptions": true
}'
{
  "favoritedOrder": 123,
  "enforceMultivalueUniqueness": true,
  "readOnlyValue": false,
  "hidden": false,
  "optionSortStrategy": "",
  "displayOrder": 123,
  "description": "",
  "showCurrencySymbol": false,
  "type": "",
  "readOnlyDefinition": false,
  "hubspotDefined": false,
  "allowedObjectTypes": "",
  "createdAt": 123,
  "searchTextAnalysisMode": "NONE",
  "textDisplayHint": "",
  "portalId": 123,
  "options": "",
  "isPartial": false,
  "optionsAreMutable": false,
  "hasUniqueValue": false,
  "calculated": false,
  "externalOptions": false,
  "dateDisplayHint": "absolute",
  "favorited": false,
  "updatedAt": 123,
  "createdUserId": 123,
  "canArchive": true,
  "fromUserId": 123,
  "mutableDefinitionNotDeletable": false,
  "isMultiValued": false,
  "sensitiveDataCategories": "",
  "canRestore": true,
  "currencyPropertyName": "",
  "owningAppId": 123,
  "isCustomizedDefault": false,
  "label": "",
  "formField": false,
  "displayMode": "",
  "dataSensitivity": "",
  "groupName": "",
  "deleted": false,
  "referencedObjectType": "",
  "name": "",
  "searchableInGlobalSearch": false,
  "externalOptionsReferenceType": "",
  "numberDisplayHint": "",
  "fieldType": ""
}
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

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
string
required
​
objectType
string
required

Body

application/json
​
label
string
required
​
type
enum<string>
required
Available options:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string
​
groupName
string
required
​
name
string
required
​
fieldType
enum<string>
required
Available options:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
hidden
boolean
​
displayOrder
integer
​
description
string
​
formField
boolean
​
dataSensitivity
enum<string>
Available options:
non_sensitive,
sensitive,
highly_sensitive
​
referencedObjectType
string
​
options
object[]
​
calculationFormula
string
​
hasUniqueValue
boolean
​
externalOptions
boolean

Response

successful operation

A HubSpot property

​
favoritedOrder
integer
required

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

​
enforceMultivalueUniqueness
boolean
required
​
readOnlyValue
boolean
required

Indica se o valor da propriedade é somente leitura.

Example:

false

​
hidden
boolean
required

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

Example:

false

​
optionSortStrategy
enum<string>
required

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

Available options:
DISPLAY_ORDER,
ALPHABETICAL
Example:

""

​
displayOrder
integer
required

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

​
description
string
required

Um resumo da finalidade da propriedade.

Example:

""

​
showCurrencySymbol
boolean
required

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

Example:

false

​
type
enum<string>
required

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

Available options:
string,
number,
bool,
datetime,
enumeration,
date,
phone_number,
currency_number,
json,
object_coordinates
Example:

""

​
readOnlyDefinition
boolean
required

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

Example:

false

​
hubspotDefined
boolean
required

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

Example:

false

​
allowedObjectTypes
object[]
required

Tipos de objetos autorizados a usar esta propriedade.

Example:

""

​
createdAt
integer
required

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

​
searchTextAnalysisMode
enum<string>
required
Available options:
NONE,
NOT_ANALYZED_TEXT
​
textDisplayHint
enum<string>
required

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

Available options:
unformatted_single_line,
multi_line,
email,
phone_number,
domain_name,
ip_address,
physical_address,
postal_code
Example:

""

​
portalId
integer
required

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

​
options
object[]
required

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

Example:

""

​
isPartial
boolean
required

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

Example:

false

​
optionsAreMutable
boolean
required

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

Example:

false

​
hasUniqueValue
boolean
required

Se a propriedade é uma propriedade de identificador exclusivo.

Example:

false

​
calculated
boolean
required

Se a propriedade é um campo calculado.

Example:

false

​
externalOptions
boolean
required

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

Example:

false

​
dateDisplayHint
enum<string>
required
Available options:
absolute,
absolute_with_relative,
time_since,
time_until
​
favorited
boolean
required

Obsoleto. Se a propriedade está marcada como favorita.

Example:

false

​
updatedAt
integer
required

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

​
createdUserId
integer
required

O ID do usuário que criou a propriedade.

​
canArchive
boolean
required
​
fromUserId
integer
required

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

​
mutableDefinitionNotDeletable
boolean
required

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

Example:

false

​
isMultiValued
boolean
required

Se a propriedade pode conter vários valores.

Example:

false

​
sensitiveDataCategories
string[]
required

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

Example:

""

​
canRestore
boolean
required
​
currencyPropertyName
string
required

O nome da propriedade de moeda relacionada.

Example:

""

​
owningAppId
integer
required
​
isCustomizedDefault
boolean
required

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

Example:

false

​
label
string
required

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

Example:

""

​
formField
boolean
required

Se a propriedade pode aparecer em formulários.

Example:

false

​
displayMode
enum<string>
required

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

Available options:
current_value,
all_unique_versions
Example:

""

​
dataSensitivity
enum<string>
required

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

Available options:
none,
standard,
high
Example:

""

​
groupName
string
required

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

Example:

""

​
deleted
boolean
required

Se a propriedade foi excluída.

Example:

false

​
referencedObjectType
enum<string>
required

Obsoleto. Em vez disso, use externalOptionsReferenceType.

Available options:
CONTACT,
COMPANY,
DEAL,
ENGAGEMENT,
TICKET,
OWNER,
PRODUCT,
LINE_ITEM,
BET_DELIVERABLE_SERVICE,
CONTENT,
CONVERSATION,
BET_ALERT,
PORTAL,
QUOTE,
FORM_SUBMISSION_INBOUNDDB,
QUOTA,
UNSUBSCRIBE,
COMMUNICATION,
FEEDBACK_SUBMISSION,
ATTRIBUTION,
SALESFORCE_SYNC_ERROR,
RESTORABLE_CRM_OBJECT,
HUB,
LANDING_PAGE,
PRODUCT_OR_FOLDER,
TASK,
FORM,
MARKETING_EMAIL,
AD_ACCOUNT,
AD_CAMPAIGN,
AD_GROUP,
AD,
KEYWORD,
CAMPAIGN,
SOCIAL_CHANNEL,
SOCIAL_POST,
SITE_PAGE,
BLOG_POST,
IMPORT,
EXPORT,
CTA,
TASK_TEMPLATE,
AUTOMATION_PLATFORM_FLOW,
OBJECT_LIST,
NOTE,
MEETING_EVENT,
CALL,
EMAIL,
PUBLISHING_TASK,
CONVERSATION_SESSION,
CONTACT_CREATE_ATTRIBUTION,
INVOICE,
MARKETING_EVENT,
CONVERSATION_INBOX,
CHATFLOW,
MEDIA_BRIDGE,
SEQUENCE,
SEQUENCE_STEP,
FORECAST,
SNIPPET,
TEMPLATE,
DEAL_CREATE_ATTRIBUTION,
QUOTE_TEMPLATE,
QUOTE_MODULE,
QUOTE_MODULE_FIELD,
QUOTE_FIELD,
SEQUENCE_ENROLLMENT,
SUBSCRIPTION,
ACCEPTANCE_TEST,
SOCIAL_BROADCAST,
DEAL_SPLIT,
DEAL_REGISTRATION,
GOAL_TARGET,
GOAL_TARGET_GROUP,
PORTAL_OBJECT_SYNC_MESSAGE,
FILE_MANAGER_FILE,
FILE_MANAGER_FOLDER,
SEQUENCE_STEP_ENROLLMENT,
APPROVAL,
APPROVAL_STEP,
CTA_VARIANT,
SALES_DOCUMENT,
DISCOUNT,
FEE,
TAX,
MARKETING_CALENDAR,
PERMISSIONS_TESTING,
PRIVACY_SCANNER_COOKIE,
DATA_SYNC_STATE,
WEB_INTERACTIVE,
PLAYBOOK,
FOLDER,
PLAYBOOK_QUESTION,
PLAYBOOK_SUBMISSION,
PLAYBOOK_SUBMISSION_ANSWER,
COMMERCE_PAYMENT,
GSC_PROPERTY,
SOX_PROTECTED_DUMMY_TYPE,
BLOG_LISTING_PAGE,
QUARANTINED_SUBMISSION,
PAYMENT_SCHEDULE,
PAYMENT_SCHEDULE_INSTALLMENT,
MARKETING_CAMPAIGN_UTM,
DISCOUNT_TEMPLATE,
DISCOUNT_CODE,
FEEDBACK_SURVEY,
CMS_URL,
SALES_TASK,
SALES_WORKLOAD,
USER,
POSTAL_MAIL,
SCHEMAS_BACKEND_TEST,
PAYMENT_LINK,
SUBMISSION_TAG,
CAMPAIGN_STEP,
SCHEDULING_PAGE,
SOX_PROTECTED_TEST_TYPE,
ORDER,
MARKETING_SMS,
PARTNER_ACCOUNT,
CAMPAIGN_TEMPLATE,
CAMPAIGN_TEMPLATE_STEP,
PLAYLIST,
CLIP,
CAMPAIGN_BUDGET_ITEM,
CAMPAIGN_SPEND_ITEM,
MIC,
CONTENT_AUDIT,
CONTENT_AUDIT_PAGE,
PLAYLIST_FOLDER,
LEAD,
ABANDONED_CART,
EXTERNAL_WEB_URL,
VIEW,
VIEW_BLOCK,
ROSTER,
CART,
AUTOMATION_PLATFORM_FLOW_ACTION,
SOCIAL_PROFILE,
PARTNER_CLIENT,
ROSTER_MEMBER,
MARKETING_EVENT_ATTENDANCE,
ALL_PAGES,
AI_FORECAST,
CRM_PIPELINES_DUMMY_TYPE,
KNOWLEDGE_ARTICLE,
PROPERTY_INFO,
DATA_PRIVACY_CONSENT,
GOAL_TEMPLATE,
SCORE_CONFIGURATION,
AUDIENCE,
PARTNER_CLIENT_REVENUE,
AUTOMATION_JOURNEY,
COMBO_EVENT_CONFIGURATION,
CRM_OBJECTS_DUMMY_TYPE,
CASE_STUDY,
SERVICE,
PODCAST_EPISODE,
PARTNER_SERVICE,
PROSPECTING_AGENT_CONTACT_ASSIGNMENT,
UNKNOWN
Example:

""

​
name
string
required

O nome interno da propriedade.

Example:

""

​
searchableInGlobalSearch
boolean
required

Se a propriedade pode ser pesquisada globalmente.

Example:

false

​
externalOptionsReferenceType
string
required

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).

Example:

""

​
numberDisplayHint
enum<string>
required

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

Available options:
unformatted,
formatted,
currency,
percentage,
duration,
probability
Example:

""

​
fieldType
string
required

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

Example:

""

⌘I