API documentation

GET /contact_field_values

Authorization Required

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

List records.

List the picklist values defined for your contact fields, optionally filtered to a single contact field by id.

Params

Param name	Description
contact_field_id Optional	The Contact Field this picklist value belongs to. Must be a valid foreign key reference to an Contact Field. Refer to: /api/docs/1.0/contact_fields
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id contact_field_id sortable_order key value name record_token_filter_id record_token_filter_data_count record_token_filter_data Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "contact_field_values": [
    {
      "id": 10001,
      "type": "ContactFieldValue",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T13:30:00.000Z",
      "updated_at": "2026-01-15T14:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/contact_field_values/10001",
      "routes_edit_path": "/contact_field_values/10001/edit",
      "external_record_id": null,
      "contact_field_id": 10002,
      "sortable_order": 0,
      "key": null,
      "value": "yes",
      "name": "Yes (updated)",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": 10003,
      "type": "ContactFieldValue",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/contact_field_values/10003",
      "routes_edit_path": "/contact_field_values/10003/edit",
      "external_record_id": null,
      "contact_field_id": 10004,
      "sortable_order": 0,
      "key": "full_name",
      "value": "yes",
      "name": "Yes",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": 10005,
      "type": "ContactFieldValue",
      "uuid": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/contact_field_values/10005",
      "routes_edit_path": "/contact_field_values/10005/edit",
      "external_record_id": null,
      "contact_field_id": 10004,
      "sortable_order": 1,
      "key": "full_name",
      "value": "no",
      "name": "No",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "contact_field_values",
    "page": 1,
    "total_pages": 1,
    "per_page": 10000,
    "total_count": 3,
    "next_cursor": 10006
  }
}

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"
  }
}

POST /contact_field_values

Authorization Required

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

Create record.

Add a new picklist value (and its display name) to a contact field.

Params

Param name	Description
contact_field_id Required	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 Required	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 -X POST 'https://[your-subdomain].trackdrive.com/api/v1/contact_field_values/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "contact_field_id": 10001,
  "value": "yes",
  "name": "Yes"
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "contact_field_value": {
    "id": 10002,
    "type": "ContactFieldValue",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/contact_field_values/10002",
    "routes_edit_path": "/contact_field_values/10002/edit",
    "external_record_id": null,
    "contact_field_id": 10001,
    "sortable_order": 1,
    "key": "vehicle_year",
    "value": "yes",
    "name": "Yes",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "contact_field_value"
  }
}

GET /contact_field_values/:id

Authorization Required

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

Get record by id.

Get the details of a single contact field picklist value by id.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact_field_value": {
    "id": 10001,
    "type": "ContactFieldValue",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T14:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/contact_field_values/10001",
    "routes_edit_path": "/contact_field_values/10001/edit",
    "external_record_id": null,
    "contact_field_id": 10002,
    "sortable_order": 0,
    "key": null,
    "value": "yes",
    "name": "Yes (updated)",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "contact_field_value"
  }
}

PUT /contact_field_values/:id

Authorization Required

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

Update record by id.

Update the value or display name of an existing contact field picklist value.

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 -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/contact_field_values/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "No (updated)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact_field_value": {
    "id": 10001,
    "type": "ContactFieldValue",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/contact_field_values/10001",
    "routes_edit_path": "/contact_field_values/10001/edit",
    "external_record_id": null,
    "contact_field_id": 10002,
    "sortable_order": 2,
    "key": "vehicle_year",
    "value": "no",
    "name": "No (updated)",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "contact_field_value"
  }
}

DELETE /contact_field_values/:id

Authorization Required

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

Destroy record by id.

Permanently remove a picklist value from its contact field.

Example Request

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

Example Response 204

Params

Must be any combination of:

Params

Params

Params