Param name |
Description
Validations
|
---|---|
offer_id Optional |
Translation missing: en.api.contact_field_views.offer_id
|
ids Optional |
Return records matching these ids.
|
page Optional |
Return the next page of results.
|
per_page Optional |
How many results to return per page. The default is 25.
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
fulltext Optional |
Search for any record that matches this text
|
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:
|
root Optional |
Pass
|
Param name |
Description
Validations
|
---|---|
offer_id Optional |
Assign the record to this Offer.
|
title Optional Blank Value Allowed |
Agent Script Display Name
|
fields_type Optional Blank Value Allowed |
A unique value that will be submitted with leads to select this field type and agent script.
|
script_html Optional Blank Value Allowed |
This script will be displayed to agents when they are answering calls from consumers. Contact fields in this script will be replaced with inputs, allowing the agent to enter responses inline in the script.
|
token_keys Optional Blank Value Allowed |
These fields will be visible when this field_type is selected.
|
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.
|
Param name |
Description
Validations
|
---|---|
title Required |
Agent Script Display Name
|
offer_id Required |
Assign the record to this Offer.
|
fields_type Optional Blank Value Allowed |
A unique value that will be submitted with leads to select this field type and agent script.
|
script_html Optional Blank Value Allowed |
This script will be displayed to agents when they are answering calls from consumers. Contact fields in this script will be replaced with inputs, allowing the agent to enter responses inline in the script.
|
token_keys Optional Blank Value Allowed |
These fields will be visible when this field_type is selected.
|
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.
|
Param name |
Description
Validations
|
---|---|
offer_id Optional |
Assign the record to this Offer.
|
title Optional |
Agent Script Display Name
|
fields_type Optional Blank Value Allowed |
A unique value that will be submitted with leads to select this field type and agent script.
|
script_html Optional Blank Value Allowed |
This script will be displayed to agents when they are answering calls from consumers. Contact fields in this script will be replaced with inputs, allowing the agent to enter responses inline in the script.
|
token_keys Optional Blank Value Allowed |
These fields will be visible when this field_type is selected.
|
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.
|