Zum Hauptinhalt springen
POST
/
crm
/
v3
/
properties
/
{objectType}
プロパティーを作成
curl --request POST \
  --url https://api.hubapi.com/crm/v3/properties/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hasUniqueValue": false,
  "hidden": false,
  "label": "My Contact Property",
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}'
{
  "location": "<string>",
  "createdResourceId": "<string>",
  "entity": {
    "displayOrder": 2,
    "fieldType": "select",
    "formField": true,
    "groupName": "contactinformation",
    "hasUniqueValue": false,
    "hidden": false,
    "label": "My Contact Property",
    "modificationMetadata": {
      "archivable": true,
      "readOnlyDefinition": false,
      "readOnlyOptions": false,
      "readOnlyValue": false
    },
    "name": "my_contact_property",
    "options": [
      {
        "description": "Choice number one",
        "displayOrder": 1,
        "hidden": false,
        "label": "Option A",
        "value": "A"
      },
      {
        "description": "Choice number two",
        "displayOrder": 2,
        "hidden": false,
        "label": "Option B",
        "value": "B"
      }
    ],
    "type": "enumeration"
  }
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -Starter
この API には、次のいずれかのスコープが必要です。
crm.objects.carts.write
crm.objects.orders.write
crm.objects.users.write
crm.pipelines.orders.write
crm.schemas.appointments.write
crm.schemas.carts.write
crm.schemas.commercepayments.write
crm.schemas.companies.write
crm.schemas.contacts.write
crm.schemas.courses.write
crm.schemas.deals.write
crm.schemas.invoices.write
crm.schemas.listings.write
crm.schemas.orders.write
crm.schemas.services.write
crm.schemas.subscriptions.write
e-commerce
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required

Body

application/json
​
label
string
required

HubSpotに表示される、人間が読めるプロパティーラベル。

​
type
enum<string>
required

プロパティーのデータ型。

Verfügbare Optionen:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string
​
groupName
string
required

プロパティーが含まれているプロパティーグループの名前。

​
name
string
required

このAPIを使用してプロパティーを参照する際に使用する必要がある内部プロパティー名。

​
fieldType
enum<string>
required

HubSpotでのプロパティーの表示が制御されます。

Verfügbare Optionen:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
hidden
boolean

trueの場合、このオプションはフォーム、ボット、またはミーティング設定ページに表示されません。コンタクト、会社、チケット、およびカスタムオブジェクトの列挙プロパティーではサポートされています。

​
displayOrder
integer

プロパティーは、最も小さい正の整数値を先頭に表示されます。「-1」という値にすると、そのプロパティーは全ての正の値よりも後に表示されます。

​
description
string

HubSpotにヘルプテキストとして表示されるプロパティーの説明。

​
formField
boolean

HubSpotフォームにプロパティーを使用できるかどうか。

​
dataSensitivity
enum<string>
Verfügbare Optionen:
non_sensitive,
sensitive,
highly_sensitive
​
referencedObjectType
string

「externalOptions」がtrueの場合、「OWNER」に設定する必要があります。これにより、現在のHubSpotユーザーのオプション値が動的にプロパティーに取り込まれます。

​
options
object[]

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

​
calculationFormula
string

計算プロパティーの計算に使用される式を表します。

​
hasUniqueValue
boolean

プロパティーの値が固有である必要があるかどうか。設定すると、変更はできません。

​
externalOptions
boolean

「列挙」タイプのプロパティーにのみ適用されます。「referencedObjectType」が「OWNER」の場合はtrueに設定する必要があります。それ以外の場合はfalseに設定します。

Response

successful operation

​
createdResourceId
string
required
​
entity
object
required

A HubSpot property

Example:
{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hasUniqueValue": false,
  "hidden": false,
  "label": "My Contact Property",
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": false,
    "readOnlyOptions": false,
    "readOnlyValue": false
  },
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}
​
location
string