Params

Param name
Description
key
Required

The internal token name where values are stored.

  • Must be String

name
Required

The friendly human name displayed to users.

  • Must be String

hint
Optional Blank Value Allowed

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

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

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.