/customFields

Create a custom field.

🚧

Restricted Access

This endpoint is accessible to account owners only.

Body Params
string
required

The user-friendly name of the custom field (e.g., "Anniversary").

string
enum
required

The type of custom field.

Allowed:
choices
array of strings

Array of options related to a custom field of type dropdown.

choices
boolean
Defaults to false

Whether a date field occurs every year (e.g. birthdays, anniversaries, etc.). (Note: This is only set and returned for date custom fields.)

boolean
Defaults to false

When viewing a person, we will hide this field if it is empty.

int32
Defaults to 0

A weighted integer for the field to assign values for custom sorting.

Response

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json