There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Update a deal property group

Last updated May 31, 2023

PUT /properties/v1/deals/groups/named/:group_name

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

crm.schemas.deals.write

Update a previously created deal property group.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Group Name Used in the request URL (see above) If you want to only have properties from a particular group returned to you, then you can specify a group name in your request. If you want to get properties from all groups returned to you, then you can simply omit this parameter from the request URL that you're using.
Property Group JSON Used in the request body Defines the property group and any properties within it.
Optional Parameters How to use Description
Properties Used in the request body The properties (if any) that you want to include in your updated custom property group.

Note This replaces the deprecated URL PUT /deals/v1/groups/named/:group_name

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example URL to PUT to: 'http://api.hubapi.com/properties/v1/deals/groups/named/invoicing' { "name": "invoicing", "displayName": "Updated Invoicing", "displayOrder": 6, "properties": [ { "name": "hs_campaign", "label": "Campaign", "description": "The marketing campaign the deal is associated with", "groupName": "dealinformation", "type": "string", "fieldType": "text", "options": [], "calculated": false, "readOnlyValue": false, "externalOptions": true, "formField": false, "displayOrder": -1, "readOnlyDefinition": true, "hidden": true, "mutableDefinitionNotDeletable": true, "displayMode": "current_value", "hubspotDefined": true } ] }
import requests import json url = 'http://api.hubapi.com/properties/v1/deals/groups/named/group_name' headers = {} headers['Content-Type'] = 'application/json' data = json.dumps({ "name": "group_name", "displayName": "new_group_name", "displayOrder": 6, "properties": [ { "name": "hs_campaign", "label": "Campaign", "description": "The marketing campaign the deal is associated with", "groupName": "dealinformation", "type": "string", "fieldType": "text", "options": [], "calculated": "false", "readOnlyValue": "false", "externalOptions": "true", "formField": "false", "displayOrder": -1, "readOnlyDefinition": "true", "hidden": "true", "mutableDefinitionNotDeletable": "true", "displayMode": "current_value", "hubspotDefined": "true" } ] }) r = requests.put(url = url, data = data, headers = headers ) print(r.text)