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"
}
'{
"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"
}Create a property
Create and return a copy of a new property for the specified object type.
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"
}
'{
"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"
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
Controls how the property appears in HubSpot.
booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea The name of the property group the property belongs to.
A human-readable property label that will be shown in HubSpot.
The internal property name, which must be used when referencing the property via the API.
The data type of the property.
bool, date, datetime, enumeration, number, phone_number, string Represents a formula that is used to compute a calculated property.
Indicates the sensitivity level of the property, with options: highly_sensitive, non_sensitive, or sensitive.
highly_sensitive, non_sensitive, sensitive A description of the property that will be shown as help text in HubSpot.
Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.
Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false.
Whether or not the property can be used in a HubSpot form.
Whether or not the property's value must be unique. Once set, this can't be changed.
If true, the property won't be visible and can't be used in HubSpot.
A list of valid options for the property. This field is required for enumerated properties.
Show child attributes
Show child attributes
Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users.
Response
successful operation
A HubSpot property
A description of the property that will be shown as help text in HubSpot.
Controls how the property appears in HubSpot.
The name of the property group the property belongs to.
A human-readable property label that will be shown in HubSpot.
The internal property name, which must be used when referencing the property via the API.
A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.
Show child attributes
Show child attributes
The property data type.
Whether or not the property is archived.
When the property was archived.
For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
Represents a formula that is used to compute a calculated property.
The timestamp when the property was created, in ISO 8601 format.
The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
highly_sensitive, non_sensitive, sensitive Indicates how date values should be displayed, with options such as 'absolute', 'absolute_with_relative', 'time_since', or 'time_until'.
absolute, absolute_with_relative, time_since, time_until Properties are shown in order, starting with the lowest positive integer value.
For default properties, true indicates that the options are stored externally to the property settings.
Whether or not the property can be used in a HubSpot form.
Whether or not the property's value must be unique. Once set, this can't be changed.
Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties.
false
This will be true for default object properties built into HubSpot.
Show child attributes
Show child attributes
If this property is related to other object(s), they'll be listed here.
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
Whether or not the property will display the currency symbol set in the account settings.
The timestamp when the property was last updated, in ISO 8601 format.
The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.
Was this page helpful?