Param name |
Description
Validations
|
---|---|
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
|
---|---|
key Optional Blank Value Allowed |
The internal token name where values are stored.
|
name Optional Blank Value Allowed |
The friendly human name displayed to users.
|
hint Optional Blank Value Allowed |
Display a helpful hint to users explaining the purpose of this disposition.
|
show_on_agent_widget Optional Blank Value Allowed |
Show this disposition on the agent widget?
|
show_in_tables Optional Blank Value Allowed |
Show this disposition as a column on tables?
|
show_in_reports Optional Blank Value Allowed |
Show this disposition as a column on reports?
|
apply_call_answered Optional Blank Value Allowed |
Mark the call as having been answered?
|
apply_agent_handled Optional Blank Value Allowed |
Mark the call as having been handled by an agent?
|
apply_buyer_handled Optional Blank Value Allowed |
Mark the call as having been handled by a buyer?
|
apply_end_of_schedule Optional Blank Value Allowed |
Trigger the end of schedule when selecting this disposition?
|
apply_block_caller Optional Blank Value Allowed |
Block the caller when selecting this disposition?
|
apply_auto_next_lead Optional Blank Value Allowed |
Automatically move to the next lead after selecting this disposition?
|
notes_required Optional Blank Value Allowed |
Require the agent to write notes about this call?
|
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
|
---|---|
key Required |
The internal token name where values are stored.
|
name Required |
The friendly human name displayed to users.
|
hint Optional Blank Value Allowed |
Display a helpful hint to users explaining the purpose of this disposition.
|
show_on_agent_widget Optional Blank Value Allowed |
Show this disposition on the agent widget?
|
show_in_tables Optional Blank Value Allowed |
Show this disposition as a column on tables?
|
show_in_reports Optional Blank Value Allowed |
Show this disposition as a column on reports?
|
apply_call_answered Optional Blank Value Allowed |
Mark the call as having been answered?
|
apply_agent_handled Optional Blank Value Allowed |
Mark the call as having been handled by an agent?
|
apply_buyer_handled Optional Blank Value Allowed |
Mark the call as having been handled by a buyer?
|
apply_end_of_schedule Optional Blank Value Allowed |
Trigger the end of schedule when selecting this disposition?
|
apply_block_caller Optional Blank Value Allowed |
Block the caller when selecting this disposition?
|
apply_auto_next_lead Optional Blank Value Allowed |
Automatically move to the next lead after selecting this disposition?
|
notes_required Optional Blank Value Allowed |
Require the agent to write notes about this call?
|
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
|
---|---|
key Optional Blank Value Allowed |
The internal token name where values are stored.
|
name Optional Blank Value Allowed |
The friendly human name displayed to users.
|
hint Optional Blank Value Allowed |
Display a helpful hint to users explaining the purpose of this disposition.
|
show_on_agent_widget Optional Blank Value Allowed |
Show this disposition on the agent widget?
|
show_in_tables Optional Blank Value Allowed |
Show this disposition as a column on tables?
|
show_in_reports Optional Blank Value Allowed |
Show this disposition as a column on reports?
|
apply_call_answered Optional Blank Value Allowed |
Mark the call as having been answered?
|
apply_agent_handled Optional Blank Value Allowed |
Mark the call as having been handled by an agent?
|
apply_buyer_handled Optional Blank Value Allowed |
Mark the call as having been handled by a buyer?
|
apply_end_of_schedule Optional Blank Value Allowed |
Trigger the end of schedule when selecting this disposition?
|
apply_block_caller Optional Blank Value Allowed |
Block the caller when selecting this disposition?
|
apply_auto_next_lead Optional Blank Value Allowed |
Automatically move to the next lead after selecting this disposition?
|
notes_required Optional Blank Value Allowed |
Require the agent to write notes about this call?
|
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.
|