API documentation

GET /contact_field_values/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/contact_field_values/new

Build record with defaults.

Return a blank picklist value populated with default attribute values, useful for building a create form.

Params

Param name	Description
contact_field_id Optional	Assign the record to this Contact Field. Must be a valid foreign key reference to an Contact Field. Refer to: /api/docs/1.0/contact_fields
value Optional Blank value allowed	Value Must be a String
name Optional Blank value allowed	Display Name For Value 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.
token_value_ids Optional Blank value allowed	Only offers this picklist value for calls matching these token values. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/contact_field_values/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact_field_value": {
    "id": null,
    "type": "ContactFieldValue",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/contact_field_values/new",
    "routes_edit_path": null,
    "external_record_id": null,
    "contact_field_id": null,
    "sortable_order": null,
    "key": null,
    "value": null,
    "name": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "contact_field_value"
  }
}