Data Append API resource for appending data. This incurs a per API request usage charge on your company.

GET /api/v1/data_appends
List of data appends.

Params

Param name
Description
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 String
created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String
fulltext
Optional

Search for any record that matches this text

  • Must be String
time_zone
Optional

Date ranges will be parsed using this time zone.
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
  • company_id
  • data_append_group_id
  • name
  • description
  • sortable_order
  • append_type
  • override_data
  • map_contact_field_group_ids
  • record_token_filter_id
  • record_token_filter_data_count
  • record_token_filter_data
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_data

  • Must be 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

GET /api/v1/data_appends/new
Build a new data append with default attributes.

Params

Param name
Description
description
Optional Blank Value Allowed

Description

  • Must be String
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"
record_token_additional_list
Optional Blank Value Allowed

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

  • Must be a valid list of tokens. Example tokens:
    buyer_interest:loan,another_token:value
override_data
Optional Blank Value Allowed

Override Existing Data

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
map_contact_field_group_ids
Optional Blank Value Allowed

Map Contact Field Group IDs

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
data_append_group_id
Required

Data Append Group ID

  • Must be String
append_type
Optional

Append Type

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    free_zip_codeFree Zip Code
    zip_codeAdvanced Zip Code
    addressAddress Data
    contactContact Data
    contact_plusContact+ Data
    allAll Data
name
Optional

Name

  • Must be String

POST /api/v1/data_appends
Create a data append.

Params

Param name
Description
description
Optional Blank Value Allowed

Description

  • Must be String
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"
record_token_additional_list
Optional Blank Value Allowed

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

  • Must be a valid list of tokens. Example tokens:
    buyer_interest:loan,another_token:value
override_data
Optional Blank Value Allowed

Override Existing Data

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
map_contact_field_group_ids
Optional Blank Value Allowed

Map Contact Field Group IDs

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
data_append_group_id
Required

Data Append Group ID

  • Must be String
append_type
Required

Append Type

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    free_zip_codeFree Zip Code
    zip_codeAdvanced Zip Code
    addressAddress Data
    contactContact Data
    contact_plusContact+ Data
    allAll Data
name
Required

Name

  • Must be String

GET /api/v1/data_appends/:id
Get details about a data append.

PUT /api/v1/data_appends/:id
Update a data append.

Params

Param name
Description
description
Optional Blank Value Allowed

Description

  • Must be String
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"
record_token_additional_list
Optional Blank Value Allowed

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

  • Must be a valid list of tokens. Example tokens:
    buyer_interest:loan,another_token:value
override_data
Optional Blank Value Allowed

Override Existing Data

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
map_contact_field_group_ids
Optional Blank Value Allowed

Map Contact Field Group IDs

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
data_append_group_id
Optional

Data Append Group ID

  • Must be String
append_type
Optional

Append Type

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    free_zip_codeFree Zip Code
    zip_codeAdvanced Zip Code
    addressAddress Data
    contactContact Data
    contact_plusContact+ Data
    allAll Data
name
Optional

Name

  • Must be String

DELETE /api/v1/data_appends/:id
Destroy a data append.

POST /api/v1/data_append
Request data for caller number. This incurs a per API request usage charge on your company based on data type requested.

Params

Param name
Description
caller_number
Required

The caller number to retrieve data for.

  • Must be String
fetch_type
Required

The type of data retrieval to perform. This incurs a per API request usage charge on your company based on append type, with the exception of free_zip_code.

  • Must be one of: free_zip_code, zip_code, address, contact, contact_plus, all.
columns
Optional

Specify the columns you would like returned, e.g. columns=zip_code,city,state

  • Must be String