Zum Hauptinhalt springen
PATCH
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
cURL
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"
  ]
}'
{
  "id": "123456",
  "createdAt": "2020-02-20T18:07:11.390Z",
  "updatedAt": "2020-02-21T14:13:28.818002Z",
  "labels": {
    "singular": "My object",
    "plural": "My objects"
  },
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "primaryDisplayProperty": "my_object_property",
  "portalId": 12345678,
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required

スキーマの完全修飾名またはオブジェクトタイプID。

Body

application/json

Attributes to update in your schema.

Defines attributes to update on an object type.

​
secondaryDisplayProperties
string[]

このオブジェクトのセカンダリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにセカンダリーとして表示されます。

​
requiredProperties
string[]

このタイプのオブジェクトを作成する際に「必須」となるプロパティーの名前。

​
searchableProperties
string[]

HubSpotの製品検索でこのオブジェクトタイプについてインデックスされるプロパティーの名前。

​
clearDescription
boolean
​
primaryDisplayProperty
string

このオブジェクトのプライマリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにプライマリーとして表示されます。

​
description
string
​
restorable
boolean
​
labels
object

Singular and plural labels for the object. Used in CRM display.

Example:
{
  "singular": "My object",
  "plural": "My objects"
}

Response

successful operation

Defines an object type.

​
labels
object
required

Singular and plural labels for the object. Used in CRM display.

Example:
{
  "singular": "My object",
  "plural": "My objects"
}
​
requiredProperties
string[]
required

このタイプのオブジェクトを作成する際に「必須」となるプロパティーの名前。

​
name
string
required

このオブジェクトの重複しない名前。内部使用のみ。

​
id
string
required

このオブジェクトタイプの固有ID。{meta-type}-{unique ID}として定義されます。

​
secondaryDisplayProperties
string[]

このオブジェクトのセカンダリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにセカンダリーとして表示されます。

​
objectTypeId
string
​
description
string
​
fullyQualifiedName
string
​
archived
boolean
​
createdAt
string<date-time>

オブジェクトタイプが作成された日時。

​
searchableProperties
string[]

HubSpotの製品検索でこのオブジェクトタイプについてインデックスされるプロパティーの名前。

​
portalId
integer

このオブジェクトタイプが固有であるアカウントのID。

​
primaryDisplayProperty
string

このオブジェクトのプライマリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにプライマリーとして表示されます。

​
updatedAt
string<date-time>

オブジェクトタイプが最後に更新された日時。