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>",
  "label": "<string>",
  "description": "<string>",
  "groupName": "<string>",
  "type": "string",
  "fieldType": "textarea",
  "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
}

Path Parameters

​
property_name
string
required

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

Response

200 - application/json

Deal property updated successfully

The response is of type object.