{"docs":{"name":"TrackDrive","info":"\n\u003cp\u003eTrackdrive API Reference\u003c/p\u003e\n","copyright":null,"doc_url":"/api/docs/1.0","api_url":"/api","resources":[{"doc_url":"/api/docs/1.0/call_dispositions","id":"call_dispositions","api_url":"/api","name":"Agents: Call Dispositions","short_description":"Custom outcome codes agents assign to calls that control routing, reporting, and agent workflow behavior.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_dispositions/index","name":"index","apis":[{"api_url":"/api/v1/call_dispositions","http_method":"GET","short_description":"List Call Disposition records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhint\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_on_agent_widget\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_in_tables\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_in_reports\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_call_answered\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_agent_handled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_buyer_handled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_qualified\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_callback_now\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_end_of_schedule\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_block_caller\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_auto_next_lead\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnotes_required\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfont_size\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_shadow_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackground_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nline_height\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_action_leave_voicemail\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_action_apply_opt_out\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsystem_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_when_blank\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_machine_detected\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_disposition_action_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nreuse_conference\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_add_to_schedule_suppression\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndelete_scheduled_callbacks\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscheduled_callback_chance\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/new","name":"new","apis":[{"api_url":"/api/v1/call_dispositions/new","http_method":"GET","short_description":"Build Call Disposition with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n\u003cp\u003eShow this disposition on the agent widget?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShow this disposition as a column on tables?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShow this disposition as a column on reports?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n\u003cp\u003eMark the call as having been answered?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n\u003cp\u003eMark the call as having been handled by an agent?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n\u003cp\u003eMark the call as having been handled by a buyer?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n\u003cp\u003eMark the call as having been qualified?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n\u003cp\u003eTrigger the end of schedule when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n\u003cp\u003eBlock the caller when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n\u003cp\u003eAutomatically move to the next lead after selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes_required","full_name":"notes_required","description":"\n\u003cp\u003eRequire the agent to write notes about this call?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_leave_voicemail","full_name":"call_action_leave_voicemail","description":"\n\u003cp\u003eWhen enabled, applying this disposition plays a recorded voicemail message to the caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_apply_opt_out","full_name":"call_action_apply_opt_out","description":"\n\u003cp\u003eWhen enabled, applying this disposition opts the caller out of future contact.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_machine_detected","full_name":"apply_machine_detected","description":"\n\u003cp\u003eWhen enabled, applying this disposition marks the call as having reached an answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_add_to_schedule_suppression","full_name":"apply_add_to_schedule_suppression","description":"\n\u003cp\u003eWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reuse_conference","full_name":"reuse_conference","description":"\n\u003cp\u003eWhen enabled, applying this disposition keeps the existing conference open instead of ending it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_scheduled_callbacks","full_name":"delete_scheduled_callbacks","description":"\n\u003cp\u003eWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_now","full_name":"schedule_callback_now","description":"\n\u003cp\u003eWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_chance","full_name":"scheduled_callback_chance","description":"\n\u003cp\u003eThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_blank","full_name":"use_when_blank","description":"\n\u003cp\u003eWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule whose actions run when this disposition is applied to a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button background, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text shadow, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/create","name":"create","apis":[{"api_url":"/api/v1/call_dispositions","http_method":"POST","short_description":"Create Call Disposition.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n\u003cp\u003eShow this disposition on the agent widget?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShow this disposition as a column on tables?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShow this disposition as a column on reports?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n\u003cp\u003eMark the call as having been answered?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n\u003cp\u003eMark the call as having been handled by an agent?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n\u003cp\u003eMark the call as having been handled by a buyer?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n\u003cp\u003eMark the call as having been qualified?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n\u003cp\u003eTrigger the end of schedule when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n\u003cp\u003eBlock the caller when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n\u003cp\u003eAutomatically move to the next lead after selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes_required","full_name":"notes_required","description":"\n\u003cp\u003eRequire the agent to write notes about this call?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_leave_voicemail","full_name":"call_action_leave_voicemail","description":"\n\u003cp\u003eWhen enabled, applying this disposition plays a recorded voicemail message to the caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_apply_opt_out","full_name":"call_action_apply_opt_out","description":"\n\u003cp\u003eWhen enabled, applying this disposition opts the caller out of future contact.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_machine_detected","full_name":"apply_machine_detected","description":"\n\u003cp\u003eWhen enabled, applying this disposition marks the call as having reached an answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_add_to_schedule_suppression","full_name":"apply_add_to_schedule_suppression","description":"\n\u003cp\u003eWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reuse_conference","full_name":"reuse_conference","description":"\n\u003cp\u003eWhen enabled, applying this disposition keeps the existing conference open instead of ending it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_scheduled_callbacks","full_name":"delete_scheduled_callbacks","description":"\n\u003cp\u003eWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_now","full_name":"schedule_callback_now","description":"\n\u003cp\u003eWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_chance","full_name":"scheduled_callback_chance","description":"\n\u003cp\u003eThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_blank","full_name":"use_when_blank","description":"\n\u003cp\u003eWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule whose actions run when this disposition is applied to a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button background, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text shadow, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/show","name":"show","apis":[{"api_url":"/api/v1/call_dispositions/:id","http_method":"GET","short_description":"Get Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/update","name":"update","apis":[{"api_url":"/api/v1/call_dispositions/:id","http_method":"PUT","short_description":"Update Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n\u003cp\u003eShow this disposition on the agent widget?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShow this disposition as a column on tables?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShow this disposition as a column on reports?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n\u003cp\u003eMark the call as having been answered?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n\u003cp\u003eMark the call as having been handled by an agent?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n\u003cp\u003eMark the call as having been handled by a buyer?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n\u003cp\u003eMark the call as having been qualified?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n\u003cp\u003eTrigger the end of schedule when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n\u003cp\u003eBlock the caller when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n\u003cp\u003eAutomatically move to the next lead after selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes_required","full_name":"notes_required","description":"\n\u003cp\u003eRequire the agent to write notes about this call?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_leave_voicemail","full_name":"call_action_leave_voicemail","description":"\n\u003cp\u003eWhen enabled, applying this disposition plays a recorded voicemail message to the caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_apply_opt_out","full_name":"call_action_apply_opt_out","description":"\n\u003cp\u003eWhen enabled, applying this disposition opts the caller out of future contact.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_machine_detected","full_name":"apply_machine_detected","description":"\n\u003cp\u003eWhen enabled, applying this disposition marks the call as having reached an answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_add_to_schedule_suppression","full_name":"apply_add_to_schedule_suppression","description":"\n\u003cp\u003eWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reuse_conference","full_name":"reuse_conference","description":"\n\u003cp\u003eWhen enabled, applying this disposition keeps the existing conference open instead of ending it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_scheduled_callbacks","full_name":"delete_scheduled_callbacks","description":"\n\u003cp\u003eWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_now","full_name":"schedule_callback_now","description":"\n\u003cp\u003eWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_chance","full_name":"scheduled_callback_chance","description":"\n\u003cp\u003eThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_blank","full_name":"use_when_blank","description":"\n\u003cp\u003eWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule whose actions run when this disposition is applied to a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button background, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text shadow, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_dispositions/:id","http_method":"DELETE","short_description":"Destroy Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}]}}