curl --request POST \
--url https://api.hubapi.com/crm-object-schemas/v3/schemas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"associatedObjects": [
"CONTACT"
],
"labels": {
"plural": "My objects",
"singular": "My object"
},
"metaType": "PORTAL_SPECIFIC",
"name": "my_object",
"primaryDisplayProperty": "my_object_property",
"properties": [
{
"isPrimaryDisplayLabel": true,
"label": "My object property",
"name": "my_object_property"
}
],
"requiredProperties": [
"my_object_property"
]
}
'{
"associations": [
{
"fromObjectTypeId": "2-123456",
"id": "123",
"name": "my_object_to_contact",
"toObjectTypeId": "0-1"
}
],
"createdAt": "2020-02-20T18:07:11.390Z",
"fullyQualifiedName": "p7878787_my_object\"",
"id": "123456",
"labels": {
"plural": "My objects",
"singular": "My object"
},
"metaType": "PORTAL_SPECIFIC",
"name": "my_object",
"primaryDisplayProperty": "my_object_property",
"properties": [
{
"archived": false,
"calculated": false,
"createdAt": "2020-02-20T18:07:11.802Z",
"displayOrder": -1,
"externalOptions": false,
"fieldType": "text",
"groupName": "my_object_information",
"hasUniqueValue": false,
"label": "My object property",
"name": "my_object_property",
"type": "string",
"updatedAt": "2020-02-20T18:07:11.802Z"
}
],
"requiredProperties": [
"my_object_property"
],
"searchableProperties": [
"my_object_property"
],
"updatedAt": "2020-02-20T18:09:07.555Z"
}プロパティーと関連付けを定義して、新しいカスタムオブジェクトスキーマを作成します。
curl --request POST \
--url https://api.hubapi.com/crm-object-schemas/v3/schemas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"associatedObjects": [
"CONTACT"
],
"labels": {
"plural": "My objects",
"singular": "My object"
},
"metaType": "PORTAL_SPECIFIC",
"name": "my_object",
"primaryDisplayProperty": "my_object_property",
"properties": [
{
"isPrimaryDisplayLabel": true,
"label": "My object property",
"name": "my_object_property"
}
],
"requiredProperties": [
"my_object_property"
]
}
'{
"associations": [
{
"fromObjectTypeId": "2-123456",
"id": "123",
"name": "my_object_to_contact",
"toObjectTypeId": "0-1"
}
],
"createdAt": "2020-02-20T18:07:11.390Z",
"fullyQualifiedName": "p7878787_my_object\"",
"id": "123456",
"labels": {
"plural": "My objects",
"singular": "My object"
},
"metaType": "PORTAL_SPECIFIC",
"name": "my_object",
"primaryDisplayProperty": "my_object_property",
"properties": [
{
"archived": false,
"calculated": false,
"createdAt": "2020-02-20T18:07:11.802Z",
"displayOrder": -1,
"externalOptions": false,
"fieldType": "text",
"groupName": "my_object_information",
"hasUniqueValue": false,
"label": "My object property",
"name": "my_object_property",
"type": "string",
"updatedAt": "2020-02-20T18:07:11.802Z"
}
],
"requiredProperties": [
"my_object_property"
],
"searchableProperties": [
"my_object_property"
],
"updatedAt": "2020-02-20T18:09:07.555Z"
}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
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
Object schema definition, including properties and associations.
Defines a new object type, its properties, and associations.
このオブジェクトタイプについて定義された関連付け。
Singular and plural labels for the object. Used in CRM display.
Show child attributes
{
"plural": "My objects",
"singular": "My object"
}このオブジェクトの重複しない名前。内部使用のみ。
このオブジェクトタイプについて定義されたプロパティー。
Show child attributes
このタイプのオブジェクトを作成する際に「必須」となるプロパティーの名前。
オブジェクトタイプにセンシティブとされたプロパティーを含めることができるかどうかを決定します。
オブジェクトタイプの簡単な説明。
このオブジェクトのプライマリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにプライマリーとして表示されます。
HubSpotの製品検索でこのオブジェクトタイプについてインデックスされるプロパティーの名前。
このオブジェクトのセカンダリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにセカンダリーとして表示されます。
successful operation
Defines an object schema, including its properties and associations.
特定のオブジェクトタイプについて定義された関連付け。
Show child attributes
このスキーマのオブジェクトタイプの固有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"
}スキーマのオブジェクトタイプの重複しない名前。
このオブジェクトタイプについて定義されたプロパティー。
Show child attributes
このタイプのオブジェクトを作成する際に「必須」となるプロパティーの名前。
オブジェクトスキーマが作成された日時。
ポータルIDやオブジェクト名を含む、オブジェクトの割り当てられた固有ID。
このオブジェクトのプライマリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにプライマリーとして表示されます。
HubSpotの製品検索でこのオブジェクトタイプについてインデックスされるプロパティーの名前。
このオブジェクトのセカンダリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにセカンダリーとして表示されます。
オブジェクトスキーマが最後に更新された日時。