必須スコープ
この API には、次のいずれかのスコープが必要です。crm.schemas.invoices.write
crm.schemas.orders.write
crm.schemas.commercepayments.write
crm.objects.orders.write
crm.schemas.contacts.write
tickets
tickets.sensitive.v2
e-commerce
crm.schemas.appointments.write
crm.schemas.courses.write
crm.schemas.carts.write
tickets.highly_sensitive.v2
crm.schemas.services.write
crm.schemas.deals.write
crm.pipelines.orders.write
crm.objects.users.write
crm.schemas.companies.write
crm.schemas.subscriptions.write
crm.schemas.listings.write
crm.objects.carts.write
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
HubSpotに表示される、人間が読めるプロパティーラベル。
"My Contact Property"
プロパティーのデータ型。
bool
, date
, datetime
, enumeration
, number
, phone_number
, string
"enumeration"
プロパティーが含まれているプロパティーグループの名前。
"contactinformation"
このAPIを使用してプロパティーを参照する際に使用する必要がある内部プロパティー名。
HubSpotでのプロパティーの表示が制御されます。
booleancheckbox
, calculation_equation
, checkbox
, date
, file
, html
, number
, phonenumber
, radio
, select
, text
, textarea
"select"
trueの場合、HubSpotにプロパティーは表示されず、使用できません。
プロパティーは、最も小さい正の整数値を先頭に表示されます。「-1」という値にすると、そのプロパティーは全ての正の値よりも後に表示されます。
2
HubSpotにヘルプテキストとして表示されるプロパティーの説明。
HubSpotフォームにプロパティーを使用できるかどうか。
non_sensitive
, sensitive
, highly_sensitive
「externalOptions」がtrueの場合、「OWNER」に設定する必要があります。これにより、現在のHubSpotユーザーのオプション値が動的にプロパティーに取り込まれます。
プロパティーの有効なオプションのリスト。このフィールドは列挙型のプロパティーに必要です。
"[{\"label\":\"Option A\",\"value\":\"A\",\"hidden\":false,\"description\":\"Choice number one\",\"displayOrder\":1},{\"label\":\"Option B\",\"value\":\"B\",\"hidden\":false,\"description\":\"Choice number two\",\"displayOrder\":2}]"
計算プロパティーの計算に使用される式を表します。
プロパティーの値が固有である必要があるかどうか。設定すると、変更はできません。
「列挙」タイプのプロパティーにのみ適用されます。「referencedObjectType」が「OWNER」の場合はtrueに設定する必要があります。それ以外の場合はfalseに設定します。
Response
successful operation
A HubSpot property
{
"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"
}