Saltar al contenido principal
PUT
/
properties
/
v1
/
deals
/
groups
/
named
/
{group_name}
Update a deal property group
curl --request PUT \
  --url https://api.hubapi.com/properties/v1/deals/groups/named/{group_name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
    }
  ]
}

Parámetros de ruta

group_name
string
requerido

The name of the property group you want to update.

Cuerpo

application/json
displayName
string

The displayed name of the group

displayOrder
integer

The order of the group

properties
object[]

Properties to include in the updated group

Respuesta

200 - application/json

Deal property group updated 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 13, 2026