Zum Hauptinhalt springen
PUT
/
properties
/
v1
/
deals
/
properties
/
named
/
{property_name}
Update a deal property
curl --request PUT \
  --url https://api.hubapi.com/properties/v1/deals/properties/named/{property_name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "groupName": "<string>",
  "type": "string",
  "fieldType": "textarea",
  "label": "<string>",
  "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>",
  "hubspotDefined": true,
  "createdAt": 123,
  "updatedAt": 123,
  "createdUserId": 123,
  "updatedUserId": 123
}

Pfadparameter

property_name
string
erforderlich

You must include the property name in the URL that you're using to make the request. This property name can only include lower case letters and numbers, and MUST start with a lower case letter.

Body

application/json
name
string
erforderlich

The internal name of the property

groupName
string
erforderlich

The property group that the property belongs to

type
enum<string>
erforderlich

The data type that the property stores

Verfügbare Optionen:
string,
number,
bool,
datetime,
enumeration
fieldType
enum<string>
erforderlich

Controls how the property appears when used in forms

Verfügbare Optionen:
textarea,
select,
text,
date,
file,
number,
radio,
checkbox
label
string

A human readable label for the property

description
string

A description of the property

options
object[]

Options for enumeration properties. This will OVERWRITE existing options.

displayOrder
integer

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

formField
boolean

Whether the property can be used in forms

Antwort

200 - application/json

Deal property updated 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

Verfügbare Optionen:
string,
number,
bool,
datetime,
enumeration
fieldType
enum<string>

Controls how the property appears when used in forms

Verfügbare Optionen:
textarea,
select,
text,
date,
file,
number,
radio,
checkbox
options
object[]

Options for enumeration properties

displayOrder
integer

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

formField
boolean

Whether the property can be used in forms

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

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

Last modified on April 9, 2026