Create a contact property

curl --request POST \
  --url https://api.hubapi.com/properties/v1/contacts/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>",
  "deleted": true,
  "hubspotDefined": true,
  "createdAt": 123,
  "updatedAt": 123,
  "createdUserId": 123,
  "updatedUserId": 123
}

POST

properties

contacts

properties

Create a contact property

curl --request POST \
  --url https://api.hubapi.com/properties/v1/contacts/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>",
  "deleted": true,
  "hubspotDefined": true,
  "createdAt": 123,
  "updatedAt": 123,
  "createdUserId": 123,
  "updatedUserId": 123
}

Body

application/json

name

string

required

The internal name of the property. Must be unique and start with a lowercase letter.

label

string

required

A human readable label for the property

groupName

string

required

The property group that the property belongs to

type

enum<string>

required

The data type that the property stores

Available options:

string,

number,

date,

datetime,

enumeration

fieldType

enum<string>

required

Sets the way that the property appears when used as a form field

Available options:

textarea,

text,

date,

file,

number,

select,

radio,

checkbox,

booleancheckbox

description

string

A description of the property

options

object[]

Options for enumeration properties

Show child attributes

displayOrder

integer

Used to control the default order of the property within the property group

formField

boolean

Controls whether or not the field will appear as an option when building a form

Response

201 - application/json

Contact property created successfully

name

string

The internal name of the property

label

string

A human readable label for the property

description

string

A description of the property

groupName

string

The property group that the property belongs to

type

enum<string>

The data type that the property stores

Available options:

string,

number,

date,

datetime,

enumeration

fieldType

enum<string>

Sets the way that the property appears when used as a form field

Available options:

textarea,

text,

date,

file,

number,

select,

radio,

checkbox,

booleancheckbox

options

object[]

Options for enumeration properties

Show child attributes

displayOrder

integer

Used to control the default order of the property within the property group

formField

boolean

Controls whether or not the field will appear as an option when building a form

readOnlyValue

boolean

Whether the property value is read-only

readOnlyDefinition

boolean

Whether the property definition is read-only

hidden

boolean

Whether the property is hidden

mutableDefinitionNotDeletable

boolean

Whether the property definition can be deleted

favorited

boolean

Whether the property is favorited

favoritedOrder

integer

The order of the property in the favorites list

calculated

boolean

Whether the property is calculated

externalOptions

boolean

Whether the property uses external options

displayMode

string

The display mode of the property

deleted

boolean

Whether the property has been deleted

hubspotDefined

boolean

Whether the property is defined by HubSpot

createdAt

integer

Timestamp when the property was created

updatedAt

integer

Timestamp when the property was last updated

createdUserId

integer

The ID of the user who created the property

updatedUserId

integer

The ID of the user who last updated the property

⌘I