Zum Hauptinhalt springen
POST
/
properties
/
v1
/
deals
/
groups
Create a deal property group
curl --request POST \
  --url https://api.hubapi.com/properties/v1/deals/groups/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "displayName": "<string>",
  "displayOrder": 123,
  "properties": [
    {
      "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>",
  "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>",
      "hubspotDefined": true,
      "createdAt": 123,
      "updatedAt": 123,
      "createdUserId": 123,
      "updatedUserId": 123
    }
  ]
}

Body

application/json
name
string
erforderlich

The internal name of the property group. Must be unique and use only lowercase letters, numbers, and underscores.

displayName
string
erforderlich

The displayed name of the group

displayOrder
integer

The order of the group. Defaults to -1 if omitted.

properties
object[]

Properties to include in the new group

Antwort

201 - application/json

Deal 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)

Last modified on April 9, 2026