Create a new object property

POST /properties/v2/:object_type/properties

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 that can be used with the specified object type.
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 for. Must be one of:

  • tickets
  • products
  • line_items
Property JSON Used in the request body.
See the example for details.
This is JSON that represents a new property that you're creating. This should be in JSON format - seen below in the code sample given. Also note that there are a set number of field types that you can create. These pertain to the form fields that you use in your forms to convert new contacts. Field types are as follows:
  • textarea
  • select
  • text
  • date
  • file
  • number
  • radio
  • checkbox

Also, there are certain 'types' of data that you can have populate each of these fields - these are as follows:

  • string
  • number
  • bool
  • datetime
  • enumeration