Zum Hauptinhalt springen
POST
/
media-bridge
/
v1
/
{appId}
/
properties
/
{objectType}
新規プロパティーを作成
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": ""
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

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

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

​
enforceMultivalueUniqueness
boolean
required
​
readOnlyValue
boolean
required

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

Example:

false

​
hidden
boolean
required

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

Example:

false

​
optionSortStrategy
enum<string>
required

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

Available options:
DISPLAY_ORDER,
ALPHABETICAL
Example:

""

​
displayOrder
integer
required

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

​
description
string
required

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

Example:

""

​
showCurrencySymbol
boolean
required

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

Example:

false

​
type
enum<string>
required

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

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

""

​
readOnlyDefinition
boolean
required

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

Example:

false

​
hubspotDefined
boolean
required

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

Example:

false

​
allowedObjectTypes
object[]
required

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

Example:

""

​
createdAt
integer
required

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

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

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

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

""

​
portalId
integer
required

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

​
options
object[]
required

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

Example:

""

​
isPartial
boolean
required

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

Example:

false

​
optionsAreMutable
boolean
required

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

Example:

false

​
hasUniqueValue
boolean
required

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

Example:

false

​
calculated
boolean
required

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

Example:

false

​
externalOptions
boolean
required

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

Example:

false

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

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

Example:

false

​
updatedAt
integer
required

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

​
createdUserId
integer
required

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

​
canArchive
boolean
required
​
fromUserId
integer
required

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

​
mutableDefinitionNotDeletable
boolean
required

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

Example:

false

​
isMultiValued
boolean
required

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

Example:

false

​
sensitiveDataCategories
string[]
required

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

Example:

""

​
canRestore
boolean
required
​
currencyPropertyName
string
required

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

Example:

""

​
owningAppId
integer
required
​
isCustomizedDefault
boolean
required

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

Example:

false

​
label
string
required

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

Example:

""

​
formField
boolean
required

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

Example:

false

​
displayMode
enum<string>
required

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

Available options:
current_value,
all_unique_versions
Example:

""

​
dataSensitivity
enum<string>
required

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

Available options:
none,
standard,
high
Example:

""

​
groupName
string
required

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

Example:

""

​
deleted
boolean
required

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

Example:

false

​
referencedObjectType
enum<string>
required

非推奨。代わりに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

プロパティーの内部名。

Example:

""

​
searchableInGlobalSearch
boolean
required

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

Example:

false

​
externalOptionsReferenceType
string
required

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

Example:

""

​
numberDisplayHint
enum<string>
required

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

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

""

​
fieldType
string
required

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

Example:

""

⌘I