Zum Hauptinhalt springen
POST
/
crm
/
v3
/
properties
/
{objectType}
Eigenschaft erstellen
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"
}'
{
  "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"
  },
  "location": "<string>"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Starter
Diese API erfordert einen der folgenden Bereiche:
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
​
fieldType
enum<string>
required

Steuert, wie die Eigenschaft in HubSpot angezeigt wird.

Verfügbare Optionen:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
groupName
string
required

Der Name der Eigenschaftsgruppe, zu dem diese Eigenschaft gehört.

​
label
string
required

Für Menschen lesbares Eigenschaftslabel, das in HubSpot angezeigt wird.

​
name
string
required

Der interne Name der Eigenschaft. Wird verwendet, wenn die Eigenschaft über die API referenziert wird.

​
type
enum<string>
required

Der Datentyp der Eigenschaft.

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

Stellt eine Formel dar, die zur Berechnung einer berechneten Eigenschaft verwendet wird.

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

Eine Beschreibung der Eigenschaft, die in HubSpot als Hilfetext angezeigt wird.

​
displayOrder
integer

Eigenschaften werden in dieser Reihenfolge angezeigt: Das erste angezeigte Objekt hat den niedrigsten positiven Ganzzahlwert. Bei einem Wert von -1 wird die Eigenschaft nach allen positiven Werten angezeigt.

​
externalOptions
boolean

Gilt nur für Eigenschaften vom Typ „Aufzählung“. Muss in Verbindung mit einem „referencedObjectType“ von „OWNER“ auf „true“ (wahr) festgelegt werden. Ist andernfalls „false“ (falsch).

​
formField
boolean

Ob die Eigenschaft in einem HubSpot-Formular verwendet werden kann oder nicht.

​
hasUniqueValue
boolean

Ob der Wert der Eigenschaft eindeutig sein muss oder nicht. Einmal festgelegt, kann dies nicht mehr geändert werden.

​
hidden
boolean

„true“ (wahr) verweist darauf, dass die Option nicht in Formularen, in Bots oder auf Terminplanungsseiten für Meetings angezeigt wird. Unterstützt für Kontakt-, Unternehmens-, Ticket- und benutzerdefinierte Objekt-Aufzählungseigenschaften.

​
options
object[]

Eine Liste der gültigen Optionen für die Eigenschaft. Pflichtfeld bei Aufzählungseigenschaften.

​
referencedObjectType
string

Muss auf „OWNER“ festgelegt sein, wenn „externalOptions“ wahr ist, was dazu führt, dass die Eigenschaft dynamisch Optionswerte von den aktuellen HubSpot-Benutzern bezieht.

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