/customFields/:id

Update a custom field.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

Restricted Access

This endpoint is accessible to account owners only.

📘

Field Type

You cannot change the type of a field after it has been created. You will need to delete, then recreate the field.

Path Params
int32
required

The ID of the custom field.

Body Params
string

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

choices
array of strings

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

choices
boolean
Defaults to false

Sets 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.

dropdownChoiceMap
array of int32s
Defaults to

An optional mapping that points previous dropdown choices (keys) to their new positions (values). This is used to track when options get moved or renamed. If items are missing from the keys, they will be removed. If the mapping is not supplied, then this endpoint will try to determine if items have been moved or renamed on its own.

dropdownChoiceMap
Response

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