メインコンテンツへスキップ
PATCH
/
media-bridge
/
2026-03
/
{appId}
/
properties
/
{objectType}
/
{propertyName}
プロパティーを更新
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
}
'
{
  "allowedObjectTypes": [
    {
      "innerId": 123,
      "metaTypeId": 123
    }
  ],
  "calculated": true,
  "canArchive": true,
  "canRestore": true,
  "createdAt": 123,
  "createdUserId": 123,
  "currencyPropertyName": "<string>",
  "deleted": true,
  "description": "<string>",
  "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>",
  "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,
  "searchableInGlobalSearch": true,
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "updatedAt": 123
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt

Use this file to discover all available pages before exploring further.

Supported products

承認

Authorization
string
header
必須

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

パスパラメータ

appId
integer<int32>
必須

メディアブリッジアプリのappId。メディアブリッジを使用する開発者アカウント内に複数のアプリを持つことが可能です。

objectType
string
必須

更新するプロパティーのオブジェクトタイプ。

propertyName
string
必須

更新するプロパティーの名前。

ボディ

application/json
calculationFormula
string
currencyPropertyName
string
description
string
displayOrder
integer<int32>
fieldType
enum<string>
利用可能なオプション:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
formField
boolean
groupName
string
hasUniqueValue
boolean
hidden
boolean
label
string
numberDisplayHint
enum<string>
利用可能なオプション:
currency,
duration,
formatted,
percentage,
probability,
unformatted
options
object[]
showCurrencySymbol
boolean
type
enum<string>
利用可能なオプション:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string

レスポンス

successful operation

A HubSpot property

allowedObjectTypes
object[]
必須

このプロパティーの使用が許可されているオブジェクトタイプ。

calculated
boolean
必須

プロパティーが計算フィールドかどうか。

canArchive
boolean
必須
canRestore
boolean
必須
createdAt
integer<int64>
必須

プロパティーが作成された時刻のタイムスタンプ(ISO 8601形式)。

createdUserId
integer<int64>
必須

プロパティーを作成したユーザーのID。

currencyPropertyName
string
必須

関連する通貨プロパティーの名前。

dataSensitivity
enum<string>
必須

「non_sensitive」、「sensitive」、「highly_sensitive」など、プロパティーのセンシティブ(慎重に扱うべき)レベルを示します。

利用可能なオプション:
high,
none,
standard
dateDisplayHint
enum<string>
必須
利用可能なオプション:
absolute,
absolute_with_relative,
time_since,
time_until
deleted
boolean
必須

プロパティーが削除済みかどうか。

description
string
必須

プロパティーの目的の要約。

displayMode
enum<string>
必須

プロパティーの表示モード。「current_value」または「all_unique_versions」にできます。

利用可能なオプション:
all_unique_versions,
current_value
displayOrder
integer<int32>
必須

リスト内項目の他の項目との相対位置。

enforceMultivalueUniqueness
boolean
必須
externalOptions
boolean
必須

列挙型のプロパティーにのみ適用されます。trueに設定し、「referencedObjectType」を「OWNER」に設定します。それ以外の場合はfalse。

externalOptionsReferenceType
string
必須

externalOptionsがtrueの場合、プロパティーのオプション値が他のシステムから埋められることを示します(例えば、hubspot_owner_idプロパティーの場合は「OWNER」)。

favorited
boolean
必須

非推奨。プロパティーがお気に入り済みかどうか。

favoritedOrder
integer<int32>
必須

非推奨。お気に入りにしたときの順序の位置。

fieldType
string
必須

HubSpotのUIまたはフォーム上でプロパティーがどう表示されるかを指定します。詳細はプロパティーAPIガイドをご確認ください。

formField
boolean
必須

プロパティーをフォームで表示できるかどうか。

fromUserId
integer<int64>
必須

プロパティーを最後に更新したユーザーのID。

groupName
string
必須

プロパティーが割り当てられているグループの名前。

hasUniqueValue
boolean
必須

プロパティーが固有IDプロパティーかどうか。

hidden
boolean
必須

プロパティーをHubSpot UIから非表示にするかどうか。カスタムプロパティーの場合は、これをfalseに設定することが推奨されます。

:

false

hubspotDefined
boolean
必須

HubSpotデフォルトプロパティーについてtrueに設定されるブール値。

isCustomizedDefault
boolean
必須

デフォルトプロパティーの場合、プロパティーがカスタマイズ済みかどうか。isCustomizedDefaultフィールドと同等。

isMultiValued
boolean
必須

プロパティーに複数の値を含めることができるかどうか。

isPartial
boolean
必須

デフォルトプロパティーの場合、プロパティーがカスタマイズ済みかどうか。isCustomizedDefaultフィールドと同等。

label
string
必須

プロパティーの表示ラベル。

mutableDefinitionNotDeletable
boolean
必須

プロパティー定義をカスタマイズできるが、削除はできないかどうか。

name
string
必須

プロパティーの内部名。

numberDisplayHint
enum<string>
必須

HubSpotのUIでの数値プロパティーの表示方法と検証方法に関するヒント。「unformatted」、「formatted」、「currency」、「percentage」、「duration」、「probability」のいずれかにできます。

利用可能なオプション:
currency,
duration,
formatted,
percentage,
probability,
unformatted
optionSortStrategy
enum<string>
必須

プロパティーオプションの並べ替え方法を指定します。displayOrderフィールドに従う「DISPLAY_ORDER」、または「ALPHABETICAL」のいずれかにできます。

利用可能なオプション:
ALPHABETICAL,
DISPLAY_ORDER
options
object[]
必須

プロパティーの有効なオプションのリスト。このフィールドは列挙型のプロパティーに必要です。

optionsAreMutable
boolean
必須

作成後にオプションを変更できるかどうか。

owningAppId
integer<int64>
必須
portalId
integer<int64>
必須

プロパティーが定義されているHubSpotアカウントのID。

readOnlyDefinition
boolean
必須

プロパティーの説明が読み取り専用かどうか。

readOnlyValue
boolean
必須

プロパティーの値が読み取り専用かどうかを示します。

referencedObjectType
enum<string>
必須

非推奨。代わりにexternalOptionsReferenceTypeを使用してください。

利用可能なオプション:
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>
必須
利用可能なオプション:
NONE,
NOT_ANALYZED_TEXT

プロパティーがグローバル検索可能かどうか。

sensitiveDataCategories
string[]
必須

sensitiveDataがtrueの場合、プロパティーに含まれるセンシティブデータのタイプを示します(例:「HIPAA」)。

showCurrencySymbol
boolean
必須

HubSpotのUIに通貨記号を表示するかどうか。

textDisplayHint
enum<string>
必須

HubSpotのUIでのテキストの表示方法と検証方法に関するヒント。「unformatted_single_line」、「multi_line」、「email」、「phone_number」、「domain_name」、「ip_address」、「physical_address」、「postal_code」のいずれかにできます。

利用可能なオプション:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
type
enum<string>
必須

文字列や数値など、プロパティーのデータ型。

利用可能なオプション:
bool,
currency_number,
date,
datetime,
enumeration,
json,
number,
object_coordinates,
phone_number,
string
updatedAt
integer<int64>
必須

プロパティーが最後に更新されたタイムスタンプ(ISO 8601形式)。

Last modified on April 13, 2026