There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Create a Company Property Group

Last updated May 31, 2023

POST /properties/v1/companies/groups/

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

crm.schemas.companies.write

Create a new company property group. Property groups allow you to more easily manage properties in a given portal and make contact records easier to parse for the user. If your integration is creating company properties, it's a good practice to create a new property group to include all of the properties you create.

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 "name": {name}
Used in the request body		 The internal name of the property group. Each group must have a unique name. The name must be used whenever the group is referenced using the API.
Display Name "displayName": {display name}
Used in the request body		 The displayed name of the group. The display name is used when displaying the group in the HubSpot app.
Optional Parameters How to use Description
Display Order "displayOrder": {display order}
Used in the request body		 The order of the group. When viewing company properties in HubSpot, groups are ordered in ascending order based on this value. Values of '-1' are ordered in the order they were created, after groups with positive values.

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 POST URL: https://api.hubapi.com/properties/v1/companies/groups Example Request body: { "name": "a_new_custom_group", "displayName": "A New Custom Group" } Returns a 200 on success, with the details of the new group in the body of the response: { "displayName": "A New Custom Group", "name": "a_new_custom_group", "displayOrder": 103, "hubspotDefined": false } Returns a 409 if there is already a group with that name.