Required Parameters
| Name | Description | Value Type | Possible Values | Notes |
|---|---|---|---|---|
| required_fields[] | An array of contact fields that a record must have in order to be present in the output list. | array of strings | address, email, phone, phone_multiple, phone_mobile, oa | phone_multiple and oa (online audience) must also be provided in the maximum_coverage[] field |
Optional Parameters
Name | Description | Value Type | Possible Values | Notes |
|---|---|---|---|---|
optional_fields[] | An array of contact fields that a record should include when the data is available. | array of strings | address, email, phone, phone_multiple, phone_mobile | phone_multiple must also be provided in the maximum_coverage[] field |
max_coverage[] | An array of contact fields that a record should be added to a record. This will kick off a process to append the contact fields from our additional, internal data sources. | array of strings | email, phone, phone_multiple, phone_mobile, oa | Because this option causes the system to run an append, it can greatly increase the overall processing time, i.e. from 1 minutes to multiple hours. |
max_records | The maximum number of records to return. | integer greater than 0 | ||
contacts_per_addr | Whether to return a maximum of 1 record per address. | integer | 1 | Currently only supports the value 1. |
include_demo_categories[] | An array of demographic categories that should be included in the output list. | an array of strings | b2cDemographic, b2cHouseFinAuto, b2cLifestyleInterest, b2cPoliticalDonor | |
include_filter_attrs | A boolean for whether to include any demographic filters used for creating the list, as columns in the output list. | boolean | 1 | For example, if the list is filtered by gender, then Gender will appear as a column in the output list. |
rcfg_phone_format | An integer to change the returned phone format.
| integer | 1 |