Account & Settings
App-Verwaltung
Authentifizierung
Automatisierung
CMS
Communication preferences
Konversationen
CRM
Veranstaltungen
Dateien
Marketing
Berichterstattung
Scheduler
curl --request POST \
--url https://api.hubapi.com/properties/v1/deals/properties/ \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"label": "<string>",
"groupName": "<string>",
"type": "string",
"fieldType": "textarea",
"description": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>",
"displayOrder": 123,
"hidden": true
}
],
"displayOrder": 123,
"formField": true
}
'{
"name": "<string>",
"label": "<string>",
"description": "<string>",
"groupName": "<string>",
"type": "string",
"fieldType": "textarea",
"options": [
{
"description": "<string>",
"label": "<string>",
"value": "<string>",
"displayOrder": 123,
"hidden": true,
"readOnly": true,
"doubleData": 123
}
],
"displayOrder": 123,
"formField": true,
"readOnlyValue": true,
"readOnlyDefinition": true,
"hidden": true,
"mutableDefinitionNotDeletable": true,
"favorited": true,
"favoritedOrder": 123,
"calculated": true,
"externalOptions": true,
"displayMode": "<string>",
"hubspotDefined": true,
"createdAt": 123,
"updatedAt": 123,
"createdUserId": 123,
"updatedUserId": 123
}Create a deal property
Create a property on every deal object to store a specific piece of data. In the example below, we want to store an invoice number on a separate field on deals.
curl --request POST \
--url https://api.hubapi.com/properties/v1/deals/properties/ \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"label": "<string>",
"groupName": "<string>",
"type": "string",
"fieldType": "textarea",
"description": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>",
"displayOrder": 123,
"hidden": true
}
],
"displayOrder": 123,
"formField": true
}
'{
"name": "<string>",
"label": "<string>",
"description": "<string>",
"groupName": "<string>",
"type": "string",
"fieldType": "textarea",
"options": [
{
"description": "<string>",
"label": "<string>",
"value": "<string>",
"displayOrder": 123,
"hidden": true,
"readOnly": true,
"doubleData": 123
}
],
"displayOrder": 123,
"formField": true,
"readOnlyValue": true,
"readOnlyDefinition": true,
"hidden": true,
"mutableDefinitionNotDeletable": true,
"favorited": true,
"favoritedOrder": 123,
"calculated": true,
"externalOptions": true,
"displayMode": "<string>",
"hubspotDefined": true,
"createdAt": 123,
"updatedAt": 123,
"createdUserId": 123,
"updatedUserId": 123
}Body
The internal name of the property. Must be unique and start with a lowercase letter.
A human readable label for the property
The property group that the property belongs to
The data type that the property stores
string, number, bool, datetime, enumeration Controls how the property appears when used in forms
textarea, select, text, date, file, number, radio, checkbox A description of the property
Options for enumeration properties
Show child attributes
Show child attributes
Used to control the default order of the property within the property group
Whether the property can be used in forms
Antwort
Deal property created successfully
The internal name of the property
A human readable label for the property
A description of the property
The property group that the property belongs to
The data type that the property stores
string, number, bool, datetime, enumeration Controls how the property appears when used in forms
textarea, select, text, date, file, number, radio, checkbox Options for enumeration properties
Show child attributes
Show child attributes
Used to control the default order of the property within the property group
Whether the property can be used in forms
Whether the property value is read-only
Whether the property definition is read-only
Whether the property is hidden
Whether the property definition can be deleted
Whether the property is favorited
The order of the property in the favorites list
Whether the property is calculated
Whether the property uses external options
The display mode of the property
Whether the property is defined by HubSpot
Timestamp when the property was created
Timestamp when the property was last updated
The ID of the user who created the property
The ID of the user who last updated the property