Skip to main content
POST
Eigenschaft erstellen

Supported products

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

appId
integer<int32>
erforderlich

Die eindeutige Kennung der App, in der die Eigenschaft erstellt wird.

objectType
string
erforderlich

Der Objekttyp, für den die Eigenschaft erstellt wird.

Body

application/json
fieldType
enum<string>
erforderlich

Eine Zeichenfolge, die den Feldtyp für die Eigenschaft angibt, z. B. „booleancheckbox“, „calculation_equation“, „checkbox“, „date“, „file“, „html“, „number“, „phonenumber“, „radio“, „select“, „text“ oder „textarea“.

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

Der Name der Gruppe, zu der die Eigenschaft gehört, dargestellt als Zeichenfolge.

label
string
erforderlich

Eine Zeichenfolge, die das Anzeigelabel für die Eigenschaft darstellt und in Benutzeroberflächen verwendet wird.

name
string
erforderlich

Der eindeutige Name der Eigenschaft. Es ist eine Zeichenfolge, die die Eigenschaft innerhalb des Objekttyps identifiziert.

type
enum<string>
erforderlich

Der Datentyp der Eigenschaft, der „bool“, „date“, „datetime“, „enumeration“, „number“, „phone_number“ oder „string“ sein kann.

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

Eine Zeichenfolge, die die Formel zur Berechnung des Eigenschaftswerts darstellt, anwendbar für berechnete Eigenschaften.

currencyPropertyName
string

Eine Zeichenfolge, die den Namen der Eigenschaft angibt, die zur Bestimmung der Währung für Währungseigenschaften verwendet wird.

dataSensitivity
enum<string>

Eine Zeichenfolge, die die Vertraulichkeitsstufe der Daten angibt, z. B. „PII“ (personenbezogene Daten).

Verfügbare Optionen:
highly_sensitive,
non_sensitive,
sensitive
description
string

Eine Zeichenfolge, die eine Beschreibung der Eigenschaft bereitstellt und deren Zweck oder Nutzung erläutert.

displayOrder
integer<int32>

Eine Ganzzahl, die die Reihenfolge bestimmt, in der die Eigenschaft im Verhältnis zu anderen Eigenschaften angezeigt wird.

externalOptions
boolean

Ein boolescher Wert, der angibt, ob die Eigenschaftsoptionen extern verwaltet werden.

formField
boolean

Ein boolescher Wert, der angibt, ob die Eigenschaft in Formularen verwendet werden kann.

hasUniqueValue
boolean

Ein boolescher Wert, der angibt, ob die Eigenschaft einen eindeutigen Wert über alle Datensätze hinweg haben muss.

hidden
boolean

Ein boolescher Wert, der angibt, ob die Eigenschaft in Benutzeroberflächen ausgeblendet ist.

numberDisplayHint
enum<string>

Eine Zeichenfolge, die einen Hinweis zur Anzeige von Zahleneigenschaften gibt, z. B. „unformatted“, „formatted“, „currency“, „percentage“, „duration“ und „probability“.

Verfügbare Optionen:
currency,
duration,
formatted,
percentage,
probability,
unformatted
options
object[]

Ein Array von OptionInput-Objekten, das die verfügbaren Optionen für Eigenschaften vom Typ „enumeration“ angibt.

referencedObjectType
string

Eine Zeichenfolge, die den Objekttyp angibt, den die Eigenschaft referenziert, falls zutreffend.

showCurrencySymbol
boolean

Ein boolescher Wert, der angibt, ob ein Währungssymbol für Währungseigenschaften angezeigt werden soll.

textDisplayHint
enum<string>

Eine Zeichenfolge, die einen Hinweis für die Anzeige von Texteigenschaften gibt, z. B. „unformatted_single_line“, „multi_line“, „email“, „phone_number“, „domain_name“, „ip_address“, „physical_address“ und „postal_code“.

Verfügbare Optionen:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line

Antwort

successful operation

A HubSpot property

allowedObjectTypes
object[]
erforderlich

Ein Array von Zeichenfolgen, die die Objekttypen darstellen, die für diese Eigenschaft zulässig sind.

calculated
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft berechnet wird.

canArchive
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft archiviert werden kann.

canRestore
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft wiederhergestellt werden kann.

createdAt
integer<int64>
erforderlich

Eine Zeichenfolge, die Datum und Uhrzeit der Erstellung der Eigenschaft im ISO 8601-Format darstellt.

createdUserId
integer<int64>
erforderlich

Eine Zeichenfolge, die die Benutzer-ID des Erstellers der Eigenschaft darstellt.

currencyPropertyName
string
erforderlich

Eine Zeichenfolge, die den Namen der Währungseigenschaft darstellt, die dieser Eigenschaft zugeordnet ist.

dataSensitivity
enum<string>
erforderlich

Eine Zeichenfolge, die die Vertraulichkeitsstufe der Daten angibt.

Verfügbare Optionen:
high,
none,
standard
dateDisplayHint
enum<string>
erforderlich

Eine Zeichenfolge, die einen Hinweis zur Anzeige von Datumsangaben gibt.

Verfügbare Optionen:
absolute,
absolute_with_relative,
time_since,
time_until
deleted
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft gelöscht wurde.

description
string
erforderlich

Eine Zeichenfolge mit einer Beschreibung der Eigenschaft.

displayMode
enum<string>
erforderlich

Eine Zeichenfolge, die den Anzeigemodus der Eigenschaft angibt.

Verfügbare Optionen:
all_unique_versions,
current_value
displayOrder
integer<int32>
erforderlich

Eine Ganzzahl, die die Reihenfolge angibt, in der die Eigenschaft angezeigt wird.

enforceMultivalueUniqueness
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eindeutigkeit für mehrwertige Eigenschaften erzwungen wird.

externalOptions
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft externe Optionen hat.

externalOptionsReferenceType
string
erforderlich

Eine Zeichenfolge, die den Referenz-Typ für externe Optionen angibt.

favorited
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft als Favorit markiert ist.

favoritedOrder
integer<int32>
erforderlich

Eine Ganzzahl, die die Reihenfolge einer Eigenschaft in den Favoriten angibt.

fieldType
string
erforderlich

Eine Zeichenfolge, die den Feldtyp der Eigenschaft angibt, z. B. „booleancheckbox“, „calculation_equation“, „checkbox“, „date“, „file“, „html“, „number“, „phonenumber“, „radio“, „select“, „text“ oder „textarea“.

formField
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft als Formularfeld verwendet wird.

fromUserId
integer<int64>
erforderlich

Eine Zeichenfolge, die die Benutzer-ID darstellt, von der die Eigenschaft stammt.

groupName
string
erforderlich

Eine Zeichenfolge, die den Namen der Gruppe darstellt, zu der die Eigenschaft gehört.

hasUniqueValue
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft einen eindeutigen Wert hat.

hidden
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft ausgeblendet ist.

Beispiel:

false

hubspotDefined
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft von HubSpot definiert ist.

isCustomizedDefault
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft eine angepasste Standardeinstellung ist.

isMultiValued
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft mehrere Werte haben kann.

isPartial
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaft partiell ist.

label
string
erforderlich

Eine Zeichenfolge, die das Label der Eigenschaft darstellt und zu Anzeigezwecken verwendet wird.

mutableDefinitionNotDeletable
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Eigenschaftsdefinition änderbar, aber nicht löschbar ist.

name
string
erforderlich

Eine Zeichenfolge, die den Namen der Eigenschaft darstellt.

numberDisplayHint
enum<string>
erforderlich

Eine Zeichenfolge, die einen Hinweis zur Anzeige von Zahlen enthält. Zu den Optionen gehören „unformatted“, „formatted“, „currency“, „percentage“, „duration“ und „probability“.

Verfügbare Optionen:
currency,
duration,
formatted,
percentage,
probability,
unformatted
optionSortStrategy
enum<string>
erforderlich

Eine Zeichenfolge, die die Strategie zum Sortieren von Optionen angibt.

Verfügbare Optionen:
ALPHABETICAL,
DISPLAY_ORDER
options
object[]
erforderlich

Ein Array von Optionen, die für die Eigenschaft verfügbar sind. Anwendbar, wenn der Eigenschaftstyp Optionen unterstützt.

optionsAreMutable
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Optionen für die Eigenschaft veränderbar sind.

owningAppId
integer<int64>
erforderlich

Eine Ganzzahl, die die ID der App darstellt, die für die Eigenschaft zuständig ist.

portalId
integer<int64>
erforderlich

Eine Ganzzahl, die die eindeutige ID für das Portal darstellt.

readOnlyDefinition
boolean
erforderlich

Ein boolescher Wert, der angibt, ob die Definition der Eigenschaft schreibgeschützt ist.

readOnlyValue
boolean
erforderlich

Ein boolescher Wert, der angibt, ob der Wert der Eigenschaft schreibgeschützt ist.

referencedObjectType
enum<string>
erforderlich

Eine Zeichenfolge, die den Typ des Objekts angibt, auf das die Eigenschaft verweist.

Verfügbare Optionen:
ABANDONED_CART,
ACCEPTANCE_TEST,
AD,
AD_ACCOUNT,
AD_CAMPAIGN,
AD_GROUP,
AI_FORECAST,
ALL_PAGES,
APPROVAL,
APPROVAL_STEP,
ATTRIBUTION,
AUDIENCE,
AUTOMATION_JOURNEY,
AUTOMATION_PLATFORM_FLOW,
AUTOMATION_PLATFORM_FLOW_ACTION,
BET_ALERT,
BET_DELIVERABLE_SERVICE,
BLOG_LISTING_PAGE,
BLOG_POST,
CALL,
CAMPAIGN,
CAMPAIGN_BUDGET_ITEM,
CAMPAIGN_SPEND_ITEM,
CAMPAIGN_STEP,
CAMPAIGN_TEMPLATE,
CAMPAIGN_TEMPLATE_STEP,
CART,
CASE_STUDY,
CHATFLOW,
CLIP,
CMS_URL,
COMBO_EVENT_CONFIGURATION,
COMMERCE_PAYMENT,
COMMUNICATION,
COMPANY,
CONTACT,
CONTACT_CREATE_ATTRIBUTION,
CONTENT,
CONTENT_AUDIT,
CONTENT_AUDIT_PAGE,
CONVERSATION,
CONVERSATION_INBOX,
CONVERSATION_SESSION,
CRM_OBJECTS_DUMMY_TYPE,
CRM_PIPELINES_DUMMY_TYPE,
CTA,
CTA_VARIANT,
DATA_PRIVACY_CONSENT,
DATA_SYNC_STATE,
DEAL,
DEAL_CREATE_ATTRIBUTION,
DEAL_REGISTRATION,
DEAL_SPLIT,
DISCOUNT,
DISCOUNT_CODE,
DISCOUNT_TEMPLATE,
EMAIL,
ENGAGEMENT,
EXPORT,
EXTERNAL_WEB_URL,
FEE,
FEEDBACK_SUBMISSION,
FEEDBACK_SURVEY,
FILE_MANAGER_FILE,
FILE_MANAGER_FOLDER,
FOLDER,
FORECAST,
FORM,
FORM_SUBMISSION_INBOUNDDB,
GOAL_TARGET,
GOAL_TARGET_GROUP,
GOAL_TEMPLATE,
GSC_PROPERTY,
HUB,
IMPORT,
INVOICE,
KEYWORD,
KNOWLEDGE_ARTICLE,
LANDING_PAGE,
LEAD,
LINE_ITEM,
MARKETING_CALENDAR,
MARKETING_CAMPAIGN_UTM,
MARKETING_EMAIL,
MARKETING_EVENT,
MARKETING_EVENT_ATTENDANCE,
MARKETING_SMS,
MEDIA_BRIDGE,
MEETING_EVENT,
MIC,
NOTE,
OBJECT_LIST,
ORDER,
OWNER,
PARTNER_ACCOUNT,
PARTNER_CLIENT,
PARTNER_CLIENT_REVENUE,
PARTNER_SERVICE,
PAYMENT_LINK,
PAYMENT_SCHEDULE,
PAYMENT_SCHEDULE_INSTALLMENT,
PERMISSIONS_TESTING,
PLAYBOOK,
PLAYBOOK_QUESTION,
PLAYBOOK_SUBMISSION,
PLAYBOOK_SUBMISSION_ANSWER,
PLAYLIST,
PLAYLIST_FOLDER,
PODCAST_EPISODE,
PORTAL,
PORTAL_OBJECT_SYNC_MESSAGE,
POSTAL_MAIL,
PRIVACY_SCANNER_COOKIE,
PRODUCT,
PRODUCT_OR_FOLDER,
PROPERTY_INFO,
PROSPECTING_AGENT_CONTACT_ASSIGNMENT,
PUBLISHING_TASK,
QUARANTINED_SUBMISSION,
QUOTA,
QUOTE,
QUOTE_FIELD,
QUOTE_MODULE,
QUOTE_MODULE_FIELD,
QUOTE_TEMPLATE,
RESTORABLE_CRM_OBJECT,
ROSTER,
ROSTER_MEMBER,
SALES_DOCUMENT,
SALES_TASK,
SALES_WORKLOAD,
SALESFORCE_SYNC_ERROR,
SCHEDULING_PAGE,
SCHEMAS_BACKEND_TEST,
SCORE_CONFIGURATION,
SEQUENCE,
SEQUENCE_ENROLLMENT,
SEQUENCE_STEP,
SEQUENCE_STEP_ENROLLMENT,
SERVICE,
SITE_PAGE,
SNIPPET,
SOCIAL_BROADCAST,
SOCIAL_CHANNEL,
SOCIAL_POST,
SOCIAL_PROFILE,
SOX_PROTECTED_DUMMY_TYPE,
SOX_PROTECTED_TEST_TYPE,
SUBMISSION_TAG,
SUBSCRIPTION,
TASK,
TASK_TEMPLATE,
TAX,
TEMPLATE,
TICKET,
UNKNOWN,
UNSUBSCRIBE,
USER,
VIEW,
VIEW_BLOCK,
WEB_INTERACTIVE
searchTextAnalysisMode
enum<string>
erforderlich

Eine Zeichenfolge, die den Modus der Textanalyse für Suchzwecke angibt.

Verfügbare Optionen:
NONE,
NOT_ANALYZED_TEXT

Ein boolescher Wert, der angibt, ob die Eigenschaft in der globalen Suche durchsuchbar ist.

sensitiveDataCategories
string[]
erforderlich

Ein Array von Zeichenfolgen, die die Kategorien vertraulicher Daten darstellen, die dieser Eigenschaft zugeordnet sind.

showCurrencySymbol
boolean
erforderlich

Ein boolescher Wert, der angibt, ob das Währungssymbol für die Eigenschaft angezeigt werden soll.

textDisplayHint
enum<string>
erforderlich

Eine Zeichenfolge, die einen Hinweis zur Textanzeige gibt. Zu den Optionen gehören „unformatted_single_line“, „multi_line“, „email“, „phone_number“, „domain_name“, „ip_address“, „physical_address“ und „postal_code“.

Verfügbare Optionen:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
type
enum<string>
erforderlich

Eine Zeichenfolge, die den Typ der Eigenschaft angibt, z. B. „bool“, „date“, „datetime“, „enumeration“, „number“, „phone_number“ oder „string“.

Verfügbare Optionen:
bool,
currency_number,
date,
datetime,
enumeration,
json,
number,
object_coordinates,
phone_number,
string
updatedAt
integer<int64>
erforderlich

Eine Zeichenfolge, die Datum und Uhrzeit der letzten Aktualisierung der Eigenschaft im ISO 8601-Format darstellt.

Zuletzt geändert am 1. April 2026