Account & Settings
App-Verwaltung
Authentifizierung
Automatisierung
CMS
Communication preferences
Konversationen
CRM
- HubSpot CRM embed
- CRM search
- Understanding the CRM APIs
- Using Object APIs
- Properties API
- POSTCreate a property
- GETRead all properties
- GETRead a property
- Access and manage Sensitive Data
- PATCHUpdate a property
- DELArchive a property
- GETGet Contact Property Group Details
- GETGet Contact Property Groups
- GETGet a contact property
- GETGet all contact properties
- POSTCreate a contact property group
- POSTCreate a contact property
- PUTUpdate a contact property group
- PUTUpdate a contact property
- DELDelete a contact property group
- DELDelete a contact property
Veranstaltungen
Dateien
Marketing
Berichterstattung
Scheduler
curl --request PUT \
--url https://api.hubapi.com/properties/v1/contacts/properties/named/{property_name} \
--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>",
"deleted": true,
"hubspotDefined": true,
"createdAt": 123,
"updatedAt": 123,
"createdUserId": 123,
"updatedUserId": 123
}Update a contact property
This endpoint is used to update a specified contact property. See the page for creating a property for more details about how type and fieldtype related to each other.
curl --request PUT \
--url https://api.hubapi.com/properties/v1/contacts/properties/named/{property_name} \
--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>",
"deleted": true,
"hubspotDefined": true,
"createdAt": 123,
"updatedAt": 123,
"createdUserId": 123,
"updatedUserId": 123
}Pfadparameter
You must include the property name in the URL that you're using to make the request. This property name can only include lower case letters and numbers, and MUST start with a lower case letter.
Body
The internal name of the property
A human readable label for the property
The property group that the property belongs to
The data type that the property stores
string, number, date, datetime, enumeration Sets the way that the property appears when used as a form field
textarea, text, date, file, number, select, radio, checkbox, booleancheckbox A description of the property
Options for enumeration properties. This will OVERWRITE existing options.
Show child attributes
Show child attributes
Used to control the default order of the property within the property group
Controls whether or not the field will appear as an option when building a form
Antwort
Contact property updated 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, date, datetime, enumeration Sets the way that the property appears when used as a form field
textarea, text, date, file, number, select, radio, checkbox, booleancheckbox Options for enumeration properties
Show child attributes
Show child attributes
Used to control the default order of the property within the property group
Controls whether or not the field will appear as an option when building a form
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 has been deleted
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