Skip to main content
POST
cURL

Authorizations

X-API-KEY
string
header
required

Body

object
enum<string>
required
  • contact - contact
  • company - company
Available options:
contact,
company
field_name
string
required
Maximum string length: 255
type
enum<string>
default:text
  • text - text
  • number - number
  • date - date
  • dropdown_singleselect - dropdown_singleselect
  • dropdown_multiselect - dropdown_multiselect
Available options:
text,
number,
date,
dropdown_singleselect,
dropdown_multiselect
available_options
string[]
Maximum string length: 255

Response

OK. The field already existed; its type was applied.

object
enum<string>
required
  • contact - contact
  • company - company
Available options:
contact,
company
field_name
string
required
type
enum<string>
required
  • text - text
  • number - number
  • date - date
  • dropdown_singleselect - dropdown_singleselect
  • dropdown_multiselect - dropdown_multiselect
Available options:
text,
number,
date,
dropdown_singleselect,
dropdown_multiselect
available_options
string[]
required
source
enum<string>
required

agency: defined in the agency master schema, its type is managed there; client: defined for this workspace only.

  • agency - agency
  • client - client
Available options:
agency,
client
created_by
string | null
required

Firebase uid of the user who added it in the UI; null for fields created by the API, MCP or an import.

filter_key
string
required

The field id to use in filter conditions, e.g. custom.fit_score.