curl --request PATCH \
--url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"primaryDisplayProperty": "my_object_property",
"requiredProperties": [
"my_object_property"
],
"searchableProperties": [
"my_object_property"
]
}
'{
"createdAt": "2020-02-20T18:07:11.390Z",
"id": "123456",
"labels": {
"plural": "My objects",
"singular": "My object"
},
"metaType": "PORTAL_SPECIFIC",
"name": "my_object",
"portalId": 12345678,
"primaryDisplayProperty": "my_object_property",
"requiredProperties": [
"my_object_property"
],
"searchableProperties": [
"my_object_property"
],
"updatedAt": "2020-02-21T14:13:28.818002Z"
}Update the details for an existing object schema.
curl --request PATCH \
--url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"primaryDisplayProperty": "my_object_property",
"requiredProperties": [
"my_object_property"
],
"searchableProperties": [
"my_object_property"
]
}
'{
"createdAt": "2020-02-20T18:07:11.390Z",
"id": "123456",
"labels": {
"plural": "My objects",
"singular": "My object"
},
"metaType": "PORTAL_SPECIFIC",
"name": "my_object",
"portalId": 12345678,
"primaryDisplayProperty": "my_object_property",
"requiredProperties": [
"my_object_property"
],
"searchableProperties": [
"my_object_property"
],
"updatedAt": "2020-02-21T14:13:28.818002Z"
}The access token received from the authorization server in the OAuth 2.0 flow.
スキーマの完全修飾名またはオブジェクトタイプID。
Attributes to update in your schema.
Defines attributes to update on an object type.
オブジェクトタイプにセンシティブとされたプロパティーを含めることができるかどうかを決定します。
オブジェクトタイプの説明をクリアするかどうかを示します。
オブジェクトタイプの簡単な説明。
Singular and plural labels for the object. Used in CRM display.
Show child attributes
{
"plural": "My objects",
"singular": "My object"
}このオブジェクトのプライマリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにプライマリーとして表示されます。
このタイプのオブジェクトを作成する際に「必須」となるプロパティーの名前。
オブジェクトタイプを削除後に復元できるかどうかを指定します。
HubSpotの製品検索でこのオブジェクトタイプについてインデックスされるプロパティーの名前。
このオブジェクトのセカンダリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにセカンダリーとして表示されます。
successful operation
Defines an object type.
このオブジェクトタイプの固有ID。{meta-type}-{unique ID}として定義されます。
Singular and plural labels for the object. Used in CRM display.
Show child attributes
{
"plural": "My objects",
"singular": "My object"
}このオブジェクトの重複しない名前。内部使用のみ。
このタイプのオブジェクトを作成する際に「必須」となるプロパティーの名前。
オブジェクトタイプでセンシティブデータが含まれるプロパティーが許可されるかどうかを示します。
オブジェクトタイプがアーカイブ済みかどうかを示します。
オブジェクトタイプが作成された日時。
オブジェクトタイプの説明。
ポータルIDやオブジェクト名を含む、オブジェクトの割り当てられた固有ID。
オブジェクトタイプの固有ID。
このオブジェクトタイプが固有であるアカウントのID。
このオブジェクトのプライマリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにプライマリーとして表示されます。
HubSpotの製品検索でこのオブジェクトタイプについてインデックスされるプロパティーの名前。
このオブジェクトのセカンダリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにセカンダリーとして表示されます。
オブジェクトタイプが最後に更新された日時。