There's a new version of the HubSpot API
We're also working on a new documentation website, you're invited to check it out and give us your feedback.
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
crm.schemas.contacts.write
Create a new contact 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.
| 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": {group name} Used in the request body |
The internal name of the property group. Set the 'groupName' of a property to add that property to this group. The name should use only lowercase letters, numbers, and underscores. |
| Display Name | "displayName": {group name} Used in the request body |
A human readable name for the group. This is displayed in the HubSpot app. |
| Optional Parameters | How to use | Description |
|---|---|---|
| Display Order | "displayOrder": {positive integer} Used in the request body |
Groups are displayed in order, starting with 0, and follwed in order by positive integer. Defaults to -1 if omitted. Groups with a negative display order are displayed in the order they were created, after groups with positive values for the order. |
Example URL to POST to: https://api.hubapi.com/properties/v1/contacts/groups
Returns a 200 response with the details of the new group on success.
Returns a 409 Conflict response if there is already a group with the name, as groups must have unique names.
Returns a 400 with more details in the response body if there are any other problems with the request data.
