Skip to main content
POST
/
properties
/
v1
/
contacts
/
groups
Create a contact property group
curl --request POST \
  --url https://api.hubapi.com/properties/v1/contacts/groups \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "displayName": "<string>",
  "displayOrder": 123
}
'
{
  "name": "<string>",
  "displayName": "<string>",
  "displayOrder": 123,
  "hubspotDefined": true,
  "properties": [
    {
      "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 group. Must be unique and use only lowercase letters, numbers, and underscores.

displayName
string
required

A human readable name for the group

displayOrder
integer

Groups are displayed in order, starting with 0. Defaults to -1 if omitted.

Response

201 - application/json

Contact property group created successfully

name
string

The internal name of the property group

displayName
string

The displayed name of the group

displayOrder
integer

The order of the group when displaying properties

hubspotDefined
boolean

Whether the group is defined by HubSpot

properties
object[]

Properties in this group (only included if includeProperties=true)