PUT /contact_fields/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/contact_fields/:id

Update record by id.

Updates a Contact Field's validation rules, value formatting, or display settings.

Params

Param name Description
offer_id
Optional

Assign the record to this Offer.
key
Optional

The internal token name where values are stored.

  • Must be a String
required
Optional Blank value allowed

Is this field required?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
name
Optional Blank value allowed

The friendly human name displayed to users.

  • Must be a String
hint
Optional Blank value allowed

Display a helpful hint to users explaining the purpose of this field.

  • Must be a String
value_type
Optional Blank value allowed

Field Type

  • Must be one of: string, decimal, integer, time, boolean, expression, hidden.
decimal_places
Optional Blank value allowed

Decimal values/expressions will be rounded to this many decimal places.

  • Must be a decimal number.
value_formatter
Optional Blank value allowed

Expression Formatter

  • Must be one of: string, decimal, integer, time, boolean.
value_expression
Optional Blank value allowed

Expression

  • Must be a String
sortable_order
Optional Blank value allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

  • Must be a decimal number.
required_on_create
Optional Blank value allowed

Requires this field to have a value before a Lead can be created.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
required_on_ping
Optional Blank value allowed

Requires this field to have a value before this Offer’s buyers can be pinged.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
html_id
Optional Blank value allowed

A custom HTML id for this field’s input, used to target it with your own CSS or JavaScript.

  • Must be a String
background_color
Optional Blank value allowed

The background color used to display this field’s token, as a hex code.

  • Must be a String
text_color
Optional Blank value allowed

The text color used to display this field’s token, as a hex code.

  • Must be a String
show_in_docs
Optional Blank value allowed

Includes this field in the integration guide and posting instructions shown to your traffic sources.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_in_tables
Optional Blank value allowed

Shows this field as a column in tables throughout the app.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_in_reports
Optional Blank value allowed

Shows this field as an option when building reports.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_on_manual_dialer
Optional Blank value allowed

Shows this field on the manual dialer screen.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
check_buyer_filters_before_calling
Optional Blank value allowed

Considers this field’s value when applying buyer filters before calling.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
check_buyer_filters_allow_blank
Optional Blank value allowed

Allows a blank value to pass buyer filters instead of blocking the call.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
value_decimal_min
Optional Blank value allowed

The minimum acceptable value, used when the field type is Decimal or Integer.

  • Must be a decimal number.
value_decimal_max
Optional Blank value allowed

The maximum acceptable value, used when the field type is Decimal or Integer.

  • Must be a decimal number.
value_date_min
Optional Blank value allowed

The earliest acceptable date, used when the field type is Time.

  • Must be a String
value_date_max
Optional Blank value allowed

The latest acceptable date, used when the field type is Time.

  • Must be a String
date_picker_enabled
Optional Blank value allowed

Shows a date picker for entering this field’s value, used when the field type is Time.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
date_picker_in_future
Optional Blank value allowed

Restricts the date picker to future dates only, used when the field type is Time.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
boolean_true_text
Optional Blank value allowed

The label displayed for a true value, used when the field type is Boolean.

  • Must be a String
boolean_false_text
Optional Blank value allowed

The label displayed for a false value, used when the field type is Boolean.

  • Must be a String
include_blank
Optional Blank value allowed

Includes a blank option in the list of acceptable values, used when the field type is Boolean or String.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
contact_field_values_type
Optional Blank value allowed

Where the list of acceptable values for this field comes from.

  • Must be one of: custom, countries, usa_states, canada_provinces.
check_pattern_validation
Optional Blank value allowed

Validates this field’s value against the pattern selected in value_pattern_validation.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
value_pattern_validation
Optional Blank value allowed

The pattern this field’s value must match, used when check_pattern_validation is enabled.

  • Must be one of: date_YYYY-MM-DD, date_DD/MM/YYYY, date_DD-MM-YYYY, date_MM/DD/YYYY, date_MM-DD-YYYY, email.