Skip to main content
PATCH
Atualizar propriedade

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

appId
integer<int32>
obrigatório
objectType
string
obrigatório
propertyName
string
obrigatório

Corpo

application/json
calculationFormula
string

Uma string que representa a fórmula usada para calcular o valor da propriedade.

currencyPropertyName
string

Uma string que representa o nome da propriedade de moeda associada a esta propriedade.

description
string

Uma string que fornece uma descrição da propriedade.

displayOrder
integer<int32>

Um número inteiro que indica a ordem de exibição da propriedade.

fieldType
enum<string>

Uma string que especifica o tipo de campo da propriedade. Os valores válidos incluem 'booleancheckbox', 'calculation_equation', 'checkbox', 'date', 'file', 'html', 'number', 'phonenumber', 'radio', 'select', 'text' e 'textarea'.

Opções disponíveis:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
formField
boolean

Um booleano que indica se a propriedade é um campo de formulário.

groupName
string

Uma string que representa o nome do grupo ao qual a propriedade pertence.

hasUniqueValue
boolean

Um valor booleano que indica se a propriedade tem um valor exclusivo.

hidden
boolean

Um booleano que indica se a propriedade está oculta.

label
string

Uma string que representa o rótulo de exibição da propriedade.

numberDisplayHint
enum<string>

Uma string que fornece uma dica sobre como exibir números. Os valores válidos incluem "unformatted", "formatted", "currency", "percentage", "duration" e "probability".

Opções disponíveis:
currency,
duration,
formatted,
percentage,
probability,
unformatted
options
object[]

Uma matriz de objetos OptionInput que representam as opções disponíveis para a propriedade.

showCurrencySymbol
boolean

Um booleano que indica se o símbolo da moeda deve ser exibido para a propriedade.

textDisplayHint
enum<string>

Uma string que fornece uma dica sobre como exibir o texto. Os valores válidos incluem "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" e "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>

Uma string que indica o tipo de dados da propriedade. Os valores válidos incluem 'bool', 'date', 'datetime', 'enumeration', 'number', 'phone_number' e 'string'.

Opções disponíveis:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string

Resposta

successful operation

A HubSpot property

allowedObjectTypes
object[]
obrigatório

Uma matriz de strings que representa os tipos de objeto permitidos para esta propriedade.

calculated
boolean
obrigatório

Booleano que indica se a propriedade é calculada.

canArchive
boolean
obrigatório

Um valor booleano que indica se a propriedade pode ser arquivada.

canRestore
boolean
obrigatório

Um valor booleano que indica se a propriedade pode ser restaurada.

createdAt
integer<int64>
obrigatório

Uma string que representa a data e a hora em que a propriedade foi criada, no formato ISO 8601.

createdUserId
integer<int64>
obrigatório

Uma string que representa o ID do usuário que criou a propriedade.

currencyPropertyName
string
obrigatório

Uma string que representa o nome da propriedade de moeda associada a esta propriedade.

dataSensitivity
enum<string>
obrigatório

Uma string que indica o nível de sensibilidade dos dados.

Opções disponíveis:
high,
none,
standard
dateDisplayHint
enum<string>
obrigatório

Uma string que fornece uma dica para exibir datas.

Opções disponíveis:
absolute,
absolute_with_relative,
time_since,
time_until
deleted
boolean
obrigatório

Um valor booleano que indica se a propriedade foi excluída.

description
string
obrigatório

Uma string que fornece uma descrição da propriedade.

displayMode
enum<string>
obrigatório

Uma string que indica o modo de exibição da propriedade.

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

Um número inteiro que especifica a ordem em que a propriedade é exibida.

enforceMultivalueUniqueness
boolean
obrigatório

Um valor booleano que indica se a exclusividade é aplicada para propriedades de múltiplos valores.

externalOptions
boolean
obrigatório

Um valor booleano que indica se a propriedade tem opções externas.

externalOptionsReferenceType
string
obrigatório

Uma string que indica o tipo de referência para opções externas.

favorited
boolean
obrigatório

Um valor booleano que indica se a propriedade foi marcada como favorita.

favoritedOrder
integer<int32>
obrigatório

Um número inteiro que especifica a ordem da propriedade entre os favoritos.

fieldType
string
obrigatório

Uma string que indica o tipo de campo da propriedade, como 'booleancheckbox', 'calculation_equation', 'checkbox', 'date', 'file', 'html', 'number', 'phonenumber', 'radio', 'select', 'text' ou 'textarea'.

formField
boolean
obrigatório

Um valor booleano que indica se a propriedade é usada como um campo de formulário.

fromUserId
integer<int64>
obrigatório

Uma string que representa o ID do usuário de origem da propriedade.

groupName
string
obrigatório

Uma string que representa o nome do grupo ao qual a propriedade pertence.

hasUniqueValue
boolean
obrigatório

Um valor booleano que indica se a propriedade tem um valor exclusivo.

hidden
boolean
obrigatório

Um booleano que indica se a propriedade está oculta.

Exemplo:

false

hubspotDefined
boolean
obrigatório

Um valor booleano que indica se a propriedade é definida pela HubSpot.

isCustomizedDefault
boolean
obrigatório

Um valor booleano que indica se a propriedade é um padrão personalizado.

isMultiValued
boolean
obrigatório

Um valor booleano que indica se a propriedade pode ter vários valores.

isPartial
boolean
obrigatório

Um booleano que indica se a propriedade é parcial.

label
string
obrigatório

Uma string que representa o rótulo da propriedade, usada para fins de exibição.

mutableDefinitionNotDeletable
boolean
obrigatório

Um valor booleano que indica se a definição da propriedade é mutável, mas não pode ser excluída.

name
string
obrigatório

Uma string que representa o nome da propriedade.

numberDisplayHint
enum<string>
obrigatório

Uma string que fornece uma dica para exibir números, com opções como "unformatted", "formatted", "currency", "percentage", "duration" ou "probability".

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

Uma string que indica a estratégia usada para classificar as opções.

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

Uma matriz de opções disponíveis para a propriedade, aplicável se o tipo de propriedade permitir opções.

optionsAreMutable
boolean
obrigatório

Um valor booleano que indica se as opções da propriedade são mutáveis.

owningAppId
integer<int64>
obrigatório

Um número inteiro que representa o ID do aplicativo proprietário da propriedade.

portalId
integer<int64>
obrigatório

Um número inteiro que representa o identificador exclusivo do portal.

readOnlyDefinition
boolean
obrigatório

Um valor booleano que indica se a definição da propriedade é somente leitura.

readOnlyValue
boolean
obrigatório

Um valor booleano que indica se o valor da propriedade é somente leitura.

referencedObjectType
enum<string>
obrigatório

Uma string que indica o tipo de objeto referenciado pela propriedade.

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

Uma string que indica o modo de análise de texto para fins de pesquisa.

Opções disponíveis:
NONE,
NOT_ANALYZED_TEXT

Um valor booleano que indica se a propriedade pode ser pesquisada na pesquisa global.

sensitiveDataCategories
string[]
obrigatório

Uma matriz de strings que representa as categorias de dados confidenciais associadas a esta propriedade.

showCurrencySymbol
boolean
obrigatório

Um valor booleano que indica se o símbolo da moeda deve ser exibido para a propriedade.

textDisplayHint
enum<string>
obrigatório

Uma string que fornece uma dica para exibir texto, com opções como "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

Uma string que indica o tipo da propriedade, como 'bool', 'date', 'datetime', 'enumeration', 'number', 'phone_number' ou 'string'.

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

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

Última modificação em 10 de abril de 2026