If your account has Custom Fields enabled you will find the corresponding tab shown below on your settings page.

If you would like to enable Custom Fields in your account, please contact us.

Custom Field Types:

Text (String): Single line input
Drop Down (String): Users can select 1 value from a list of predefined options
Multi-Select Drop Down (String): Users can select many values from a list of predefined options
Date (ISO Date): Date picker
Checkbox (Bool): Boolean control
Color (Hex String): Color Picker
Paragraph Text (String): Multi-line text area
Currency (Number): Numeric input

Creating Custom Fields

On the Settings page you can create a new Custom Field which will then become available to your integration. As seen below you can optionally restrict the Custom Field to only be editable via integrations and simply be display only for users. This can be helpful in the case of calculated values or reference IDs to other systems that you do not want users editing.

Integrating Custom Fields

With every Custom Field you setup you will get a generated "Integration Property Name", which is the property you will use when interacting with this field via the API. You will use this generated property in the same manner as you would set any other property in a create or update call or read any other property in a read call. In addition, keep in mind that the values you are sending across need to conform to the specified type for the field type you selected and that if you are working with a drop down field you need to be providing values that match your predefined options.

Ex:
Updating a person's email and the above custom field example with a call to the update url and with the post body below.

Url: POST - /v2/companies/<company_id>/people/<person_id>
Body:

{
   "email": "[email protected]",
   "my_example_field": "Value 2"
}