Agents: Call Dispositions

Custom outcome codes agents assign to calls that control routing, reporting, and agent workflow behavior.

GET /call_dispositions

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/call_dispositions

List Call Disposition records.

Returns the Call Dispositions configured on the account: the outcome labels agents apply to calls, along with the behaviors each one triggers.

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 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.
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
  • sortable_order
  • key
  • name
  • hint
  • show_on_agent_widget
  • show_in_tables
  • show_in_reports
  • apply_call_answered
  • apply_agent_handled
  • apply_buyer_handled
  • apply_qualified
  • schedule_callback_now
  • apply_end_of_schedule
  • apply_block_caller
  • apply_auto_next_lead
  • notes_required
  • font_size
  • text_shadow_color
  • text_color
  • background_color
  • line_height
  • context_menu_name
  • call_action_leave_voicemail
  • call_action_apply_opt_out
  • system_status
  • use_when_blank
  • apply_machine_detected
  • schedule_id
  • call_disposition_action_ids
  • reuse_conference
  • apply_add_to_schedule_suppression
  • delete_scheduled_callbacks
  • scheduled_callback_chance
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_data
  • 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

GET /call_dispositions/new

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/call_dispositions/new

Build Call Disposition with defaults.

Returns a Call Disposition built with default attributes for previewing available fields. It is not saved.

Params

Param name Description
key
Optional Blank value allowed

The internal token name where values are stored.

  • Must be a String
name
Optional Blank value allowed

The friendly human name displayed to users.

  • Must be a String
hint
Optional Blank value allowed

Display a helpful hint to users explaining the purpose of this disposition.

  • Must be a String
show_on_agent_widget
Optional Blank value allowed

Show this disposition on the agent widget?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_in_tables
Optional Blank value allowed

Show this disposition as a column on tables?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_in_reports
Optional Blank value allowed

Show this disposition as a column on reports?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_call_answered
Optional Blank value allowed

Mark the call as having been answered?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_agent_handled
Optional Blank value allowed

Mark the call as having been handled by an agent?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_buyer_handled
Optional Blank value allowed

Mark the call as having been handled by a buyer?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_qualified
Optional Blank value allowed

Mark the call as having been qualified?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_end_of_schedule
Optional Blank value allowed

Trigger the end of schedule when selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_block_caller
Optional Blank value allowed

Block the caller when selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_auto_next_lead
Optional Blank value allowed

Automatically move to the next lead after selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
notes_required
Optional Blank value allowed

Require the agent to write notes about this call?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
call_action_leave_voicemail
Optional Blank value allowed

When enabled, applying this disposition plays a recorded voicemail message to the caller.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
call_action_apply_opt_out
Optional Blank value allowed

When enabled, applying this disposition opts the caller out of future contact.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_machine_detected
Optional Blank value allowed

When enabled, applying this disposition marks the call as having reached an answering machine.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_add_to_schedule_suppression
Optional Blank value allowed

When enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
reuse_conference
Optional Blank value allowed

When enabled, applying this disposition keeps the existing conference open instead of ending it.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
delete_scheduled_callbacks
Optional Blank value allowed

When enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
schedule_callback_now
Optional Blank value allowed

When enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
scheduled_callback_chance
Optional Blank value allowed

The percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.

  • Must be a decimal number.
use_when_blank
Optional Blank value allowed

When enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
schedule_id
Optional Blank value allowed

The schedule whose actions run when this disposition is applied to a call.
external_record_id
Optional Blank value allowed

An external identifier to associate with this disposition.

  • Must be a String
text_color
Optional Blank value allowed

The hex color of this disposition’s button text, e.g.

  • Must be a String
background_color
Optional Blank value allowed

The hex color of this disposition’s button background, e.g.

  • Must be a String
text_shadow_color
Optional Blank value allowed

The hex color of this disposition’s button text shadow, e.g.

  • Must be a String
font_size
Optional Blank value allowed

The font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.

  • Must be a decimal number.
token_value_ids
Optional Blank value allowed

Apply these additional tokens to the call when selecting this disposition?
filter_token_value_ids
Optional Blank value allowed

Only show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
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 filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
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"
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.

POST /call_dispositions

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/call_dispositions

Create Call Disposition.

Creates a Call Disposition with a unique key and name. If a soft-deleted disposition with the same key already exists, it is restored and updated instead of creating a duplicate.

Params

Param name Description
key
Required

The internal token name where values are stored.

  • Must be a String
name
Required

The friendly human name displayed to users.

  • Must be a String
hint
Optional Blank value allowed

Display a helpful hint to users explaining the purpose of this disposition.

  • Must be a String
show_on_agent_widget
Optional Blank value allowed

Show this disposition on the agent widget?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_in_tables
Optional Blank value allowed

Show this disposition as a column on tables?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_in_reports
Optional Blank value allowed

Show this disposition as a column on reports?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_call_answered
Optional Blank value allowed

Mark the call as having been answered?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_agent_handled
Optional Blank value allowed

Mark the call as having been handled by an agent?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_buyer_handled
Optional Blank value allowed

Mark the call as having been handled by a buyer?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_qualified
Optional Blank value allowed

Mark the call as having been qualified?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_end_of_schedule
Optional Blank value allowed

Trigger the end of schedule when selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_block_caller
Optional Blank value allowed

Block the caller when selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_auto_next_lead
Optional Blank value allowed

Automatically move to the next lead after selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
notes_required
Optional Blank value allowed

Require the agent to write notes about this call?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
call_action_leave_voicemail
Optional Blank value allowed

When enabled, applying this disposition plays a recorded voicemail message to the caller.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
call_action_apply_opt_out
Optional Blank value allowed

When enabled, applying this disposition opts the caller out of future contact.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_machine_detected
Optional Blank value allowed

When enabled, applying this disposition marks the call as having reached an answering machine.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_add_to_schedule_suppression
Optional Blank value allowed

When enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
reuse_conference
Optional Blank value allowed

When enabled, applying this disposition keeps the existing conference open instead of ending it.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
delete_scheduled_callbacks
Optional Blank value allowed

When enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
schedule_callback_now
Optional Blank value allowed

When enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
scheduled_callback_chance
Optional Blank value allowed

The percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.

  • Must be a decimal number.
use_when_blank
Optional Blank value allowed

When enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
schedule_id
Optional Blank value allowed

The schedule whose actions run when this disposition is applied to a call.
external_record_id
Optional Blank value allowed

An external identifier to associate with this disposition.

  • Must be a String
text_color
Optional Blank value allowed

The hex color of this disposition’s button text, e.g.

  • Must be a String
background_color
Optional Blank value allowed

The hex color of this disposition’s button background, e.g.

  • Must be a String
text_shadow_color
Optional Blank value allowed

The hex color of this disposition’s button text shadow, e.g.

  • Must be a String
font_size
Optional Blank value allowed

The font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.

  • Must be a decimal number.
token_value_ids
Optional Blank value allowed

Apply these additional tokens to the call when selecting this disposition?
filter_token_value_ids
Optional Blank value allowed

Only show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
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 filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
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"
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.

GET /call_dispositions/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/call_dispositions/:id

Get Call Disposition by id.

Returns a single Call Disposition by id, including which call behaviors it applies, such as marking the call answered, qualified, blocking the caller, or triggering end of schedule.

PUT /call_dispositions/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/call_dispositions/:id

Update Call Disposition by id.

Updates a Call Disposition's behavior flags, colors, or associated tokens. Restricted to account superusers; like create, submitting an existing key that belongs to a soft-deleted disposition restores it.

Params

Param name Description
key
Optional Blank value allowed

The internal token name where values are stored.

  • Must be a String
name
Optional Blank value allowed

The friendly human name displayed to users.

  • Must be a String
hint
Optional Blank value allowed

Display a helpful hint to users explaining the purpose of this disposition.

  • Must be a String
show_on_agent_widget
Optional Blank value allowed

Show this disposition on the agent widget?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_in_tables
Optional Blank value allowed

Show this disposition as a column on tables?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
show_in_reports
Optional Blank value allowed

Show this disposition as a column on reports?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_call_answered
Optional Blank value allowed

Mark the call as having been answered?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_agent_handled
Optional Blank value allowed

Mark the call as having been handled by an agent?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_buyer_handled
Optional Blank value allowed

Mark the call as having been handled by a buyer?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_qualified
Optional Blank value allowed

Mark the call as having been qualified?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_end_of_schedule
Optional Blank value allowed

Trigger the end of schedule when selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_block_caller
Optional Blank value allowed

Block the caller when selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_auto_next_lead
Optional Blank value allowed

Automatically move to the next lead after selecting this disposition?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
notes_required
Optional Blank value allowed

Require the agent to write notes about this call?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
call_action_leave_voicemail
Optional Blank value allowed

When enabled, applying this disposition plays a recorded voicemail message to the caller.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
call_action_apply_opt_out
Optional Blank value allowed

When enabled, applying this disposition opts the caller out of future contact.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_machine_detected
Optional Blank value allowed

When enabled, applying this disposition marks the call as having reached an answering machine.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
apply_add_to_schedule_suppression
Optional Blank value allowed

When enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
reuse_conference
Optional Blank value allowed

When enabled, applying this disposition keeps the existing conference open instead of ending it.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
delete_scheduled_callbacks
Optional Blank value allowed

When enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
schedule_callback_now
Optional Blank value allowed

When enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
scheduled_callback_chance
Optional Blank value allowed

The percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.

  • Must be a decimal number.
use_when_blank
Optional Blank value allowed

When enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
schedule_id
Optional Blank value allowed

The schedule whose actions run when this disposition is applied to a call.
external_record_id
Optional Blank value allowed

An external identifier to associate with this disposition.

  • Must be a String
text_color
Optional Blank value allowed

The hex color of this disposition’s button text, e.g.

  • Must be a String
background_color
Optional Blank value allowed

The hex color of this disposition’s button background, e.g.

  • Must be a String
text_shadow_color
Optional Blank value allowed

The hex color of this disposition’s button text shadow, e.g.

  • Must be a String
font_size
Optional Blank value allowed

The font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.

  • Must be a decimal number.
token_value_ids
Optional Blank value allowed

Apply these additional tokens to the call when selecting this disposition?
filter_token_value_ids
Optional Blank value allowed

Only show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
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 filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
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"
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.

DELETE /call_dispositions/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/call_dispositions/:id

Destroy Call Disposition by id.

Permanently deletes a Call Disposition. Restricted to account superusers; built-in system dispositions cannot be deleted.