curl --request POST \
--url https://api.hubapi.com/properties/v1/companies/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
}
'{
"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>",
"createdUserId": 123,
"updatedUserId": 123
}Create a property on every company object to store a specific piece of data. This works similarly to the way custom properties work on both the Contacts and Deals objects.
curl --request POST \
--url https://api.hubapi.com/properties/v1/companies/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
}
'{
"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>",
"createdUserId": 123,
"updatedUserId": 123
}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, date, datetime, enumeration Controls how the property appears in the HubSpot app
textarea, text, date, number, select, radio, checkbox, booleancheckbox A description of the property
Options for enumeration properties
Show child attributes
Used to control the default order of the property within the property group
Company 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, date, datetime, enumeration Controls how the property appears in the HubSpot app
textarea, text, date, number, select, radio, checkbox, booleancheckbox Options for enumeration properties
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
The ID of the user who created the property
The ID of the user who last updated the property