Create an object property group

POST /properties/v2/:object_type/groups

This endpoint is part of our developer preview program, and should be considered as a non-stable release that will be subject to bugs and breaking changes while under development. Please take this into account as you build against a release. Please subscribe to our changelog for updates.

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:

contacts

Create a new property group for the specified object type.

Property groups are used to keep related properties grouped together when viewing records in HubSpot.

If your integration creates properties for any CRM objects, it's a good practice to create a custom group that can be used for all of the properties created by your integration.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header or hapikey={key} query parameter. Used to authenticate the request. Please see this page for more details about authentication.
Object type

:object_type
Used in the request URL

The specific object that you want to create a new property group for. Must be one of:

  • tickets
  • products
  • line_items
Property group JSON

Used in the request body

The JSON formatted details for the group you want to create. See the example for details.


New Module

Add content here.