{"docs":{"name":"TrackDrive","info":"\n<p>Trackdrive API Reference</p>\n","copyright":null,"doc_url":"/api/docs/1.0","api_url":"/api","resources":{"access_control_lists":{"doc_url":"/api/docs/1.0/access_control_lists","id":"access_control_lists","api_url":"/api","name":"Teams","short_description":"API resource for managing Teams.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/access_control_lists/index","name":"index","apis":[{"api_url":"/api/v1/access_control_lists","http_method":"GET","short_description":"List Teams records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nusers_emails\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/access_control_lists/new","name":"new","apis":[{"api_url":"/api/v1/access_control_lists/new","http_method":"GET","short_description":"Build Team with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/access_control_lists/create","name":"create","apis":[{"api_url":"/api/v1/access_control_lists","http_method":"POST","short_description":"Create Team","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/access_control_lists/show","name":"show","apis":[{"api_url":"/api/v1/access_control_lists/:id","http_method":"GET","short_description":"Get Teams by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/access_control_lists/update","name":"update","apis":[{"api_url":"/api/v1/access_control_lists/:id","http_method":"PUT","short_description":"Update Team by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/access_control_lists/destroy","name":"destroy","apis":[{"api_url":"/api/v1/access_control_lists/:id","http_method":"DELETE","short_description":"Destroy Team by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin_table_exporters":{"doc_url":"/api/docs/1.0/admin_table_exporters","id":"admin_table_exporters","api_url":"/api","name":"Admin Table Exporter","short_description":"API resource for managing Admin Table Exporter.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/admin_table_exporters/index","name":"index","apis":[{"api_url":"/api/v1/admin_table_exporters","http_method":"GET","short_description":"List Admin Table Exporter records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndata_type\n</li>\n<li class='column-attempt'>\nexport_column_names\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\ncreated_at_from\n</li>\n<li class='column-attempt'>\ncreated_at_to\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\nis_live\n</li>\n<li class='column-attempt'>\ntarget_company_id\n</li>\n<li class='column-attempt'>\nexport_concurrency\n</li>\n<li class='column-attempt'>\ntotal_files_count\n</li>\n<li class='column-attempt'>\nqueued_files_count\n</li>\n<li class='column-attempt'>\nexport_seconds\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\ntotal_records_count\n</li>\n<li class='column-attempt'>\nexport_file_url\n</li>\n<li class='column-attempt'>\nserializer_type\n</li>\n<li class='column-attempt'>\nexport_timeframe\n</li>\n<li class='column-attempt'>\nfinished_generating_chunks_at\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_table_exporters/new","name":"new","apis":[{"api_url":"/api/v1/admin_table_exporters/new","http_method":"GET","short_description":"Build Admin Table Exporter with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_table_exporters/create","name":"create","apis":[{"api_url":"/api/v1/admin_table_exporters","http_method":"POST","short_description":"Create Admin Table Exporter.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_table_exporters/show","name":"show","apis":[{"api_url":"/api/v1/admin_table_exporters/:id","http_method":"GET","short_description":"Get Admin Table Exporter by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_table_exporters/update","name":"update","apis":[{"api_url":"/api/v1/admin_table_exporters/:id","http_method":"PUT","short_description":"Update Admin Table Exporter by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_table_exporters/destroy","name":"destroy","apis":[{"api_url":"/api/v1/admin_table_exporters/:id","http_method":"DELETE","short_description":"Destroy Admin Table Exporter by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin_tasks":{"doc_url":"/api/docs/1.0/admin_tasks","id":"admin_tasks","api_url":"/api","name":"Admin Task","short_description":"API resource for managing Admin Task.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/admin_tasks/index","name":"index","apis":[{"api_url":"/api/v1/admin_tasks","http_method":"GET","short_description":"List Admin Tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\n<p>Authorize requests using your token. Get it from your profile: <a href=\"https://trackdrive.com/profile/edit\">trackdrive.com/profile/edit</a></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nactive\n</li>\n<li class='column-attempt'>\nrails_model_name\n</li>\n<li class='column-attempt'>\nmethod_name\n</li>\n<li class='column-attempt'>\nsql_conditions\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\ncounter\n</li>\n<li class='column-attempt'>\nlast_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\ntarget_company_ids\n</li>\n<li class='column-attempt'>\nlimit_value\n</li>\n<li class='column-attempt'>\nslice_value\n</li>\n<li class='column-attempt'>\nbusiness_hours_open\n</li>\n<li class='column-attempt'>\nbusiness_hours_close\n</li>\n<li class='column-attempt'>\ntime_zone\n</li>\n<li class='column-attempt'>\nwith_solr_includes\n</li>\n<li class='column-attempt'>\nsql_includes\n</li>\n<li class='column-attempt'>\nmethod_arguments\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/new","name":"new","apis":[{"api_url":"/api/v1/admin_tasks/new","http_method":"GET","short_description":"Build Admin Task with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\n<p>Authorize requests using your token. Get it from your profile: <a href=\"https://trackdrive.com/profile/edit\">trackdrive.com/profile/edit</a></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/create","name":"create","apis":[{"api_url":"/api/v1/admin_tasks","http_method":"POST","short_description":"Create Admin Task.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\n<p>Authorize requests using your token. Get it from your profile: <a href=\"https://trackdrive.com/profile/edit\">trackdrive.com/profile/edit</a></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/show","name":"show","apis":[{"api_url":"/api/v1/admin_tasks/:id","http_method":"GET","short_description":"Get Admin Task by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\n<p>Authorize requests using your token. Get it from your profile: <a href=\"https://trackdrive.com/profile/edit\">trackdrive.com/profile/edit</a></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/update","name":"update","apis":[{"api_url":"/api/v1/admin_tasks/:id","http_method":"PUT","short_description":"Update Admin Task by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\n<p>Authorize requests using your token. Get it from your profile: <a href=\"https://trackdrive.com/profile/edit\">trackdrive.com/profile/edit</a></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/admin_tasks/:id","http_method":"DELETE","short_description":"Destroy Admin Task by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\n<p>Authorize requests using your token. Get it from your profile: <a href=\"https://trackdrive.com/profile/edit\">trackdrive.com/profile/edit</a></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"agent_call_dispositions":{"doc_url":"/api/docs/1.0/agent_call_dispositions","id":"agent_call_dispositions","api_url":"/api","name":"Agents / Call Dispositions","short_description":"API resource for managing Agent Call Disposition.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_call_dispositions/index","name":"index","apis":[{"api_url":"/api/v1/agent_call_dispositions","http_method":"GET","short_description":"List Agent Call Disposition records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\ncall_id\n</li>\n<li class='column-attempt'>\ncollaborator_id\n</li>\n<li class='column-attempt'>\ncall_disposition_id\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nhas_disposition\n</li>\n<li class='column-attempt'>\ncall_answered\n</li>\n<li class='column-attempt'>\nagent_handled\n</li>\n<li class='column-attempt'>\nbuyer_handled\n</li>\n<li class='column-attempt'>\nqualified\n</li>\n<li class='column-attempt'>\nend_of_schedule\n</li>\n<li class='column-attempt'>\nblock_caller\n</li>\n<li class='column-attempt'>\nnotes\n</li>\n<li class='column-attempt'>\ntext_color\n</li>\n<li class='column-attempt'>\nbackground_color\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nshort_name\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_call_dispositions/new","name":"new","apis":[{"api_url":"/api/v1/agent_call_dispositions/new","http_method":"GET","short_description":"Build Agent Call Disposition with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n<p>Call Disposition</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"notes","description":"\n<p>Notes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_call_dispositions/show","name":"show","apis":[{"api_url":"/api/v1/agent_call_dispositions/:id","http_method":"GET","short_description":"Get Agent 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/agent_call_dispositions/update","name":"update","apis":[{"api_url":"/api/v1/agent_call_dispositions/:id","http_method":"PUT","short_description":"Update Agent Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n<p>Call Disposition</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"notes","description":"\n<p>Notes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_call_dispositions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/agent_call_dispositions/:id","http_method":"DELETE","short_description":"Destroy Agent Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"agent_statuses":{"doc_url":"/api/docs/1.0/agent_statuses","id":"agent_statuses","api_url":"/api","name":"Agents: Statuses","short_description":"API resource for managing Agent Statuses.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_statuses/index","name":"index","apis":[{"api_url":"/api/v1/agent_statuses","http_method":"GET","short_description":"List Agent Status records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nhint\n</li>\n<li class='column-attempt'>\ntext_color\n</li>\n<li class='column-attempt'>\nbackground_color\n</li>\n<li class='column-attempt'>\nmute_hold_music\n</li>\n<li class='column-attempt'>\npause_agent\n</li>\n<li class='column-attempt'>\nunpause_agent\n</li>\n<li class='column-attempt'>\nsystem_status\n</li>\n<li class='column-attempt'>\nagent_billable\n</li>\n<li class='column-attempt'>\nhangup_agent_conference\n</li>\n<li class='column-attempt'>\nchallenge_idle_conference\n</li>\n<li class='column-attempt'>\nenable_enter_sound\n</li>\n<li class='column-attempt'>\nenable_exit_sound\n</li>\n<li class='column-attempt'>\nagent_pause_or_unpause\n</li>\n<li class='column-attempt'>\nsound_playlist_id\n</li>\n<li class='column-attempt'>\nskip_placing_outbound_calls\n</li>\n<li class='column-attempt'>\nspeak_lead_name_to_agent\n</li>\n<li class='column-attempt'>\nspeak_lead_name_text\n</li>\n<li class='column-attempt'>\ntimeout_agent_status_enabled\n</li>\n<li class='column-attempt'>\ntimeout_agent_status_seconds\n</li>\n<li class='column-attempt'>\ntimeout_agent_status_apply_alternate_id\n</li>\n<li class='column-attempt'>\nstart_agent_conference\n</li>\n<li class='column-attempt'>\npark_agent\n</li>\n<li class='column-attempt'>\nschedule_action_group_id\n</li>\n<li class='column-attempt'>\nspeak_name_record_token_filter_id\n</li>\n<li class='column-attempt'>\nspeak_name_record_token_filter_data_count\n</li>\n<li class='column-attempt'>\nspeak_name_record_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/new","name":"new","apis":[{"api_url":"/api/v1/agent_statuses/new","http_method":"GET","short_description":"Build Agent Status with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Hint</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\n<p>Text Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\n<p>Background Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pause_agent","full_name":"pause_agent","description":"\n<p>Translation missing: en.api.agent_statuses.pause_agent</p>\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":[]},{"name":"unpause_agent","full_name":"unpause_agent","description":"\n<p>Translation missing: en.api.agent_statuses.unpause_agent</p>\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":[]},{"name":"agent_billable","full_name":"agent_billable","description":"\n<p>Translation missing: en.api.agent_statuses.agent_billable</p>\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":[]},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\n<p>Translation missing: en.api.agent_statuses.schedule_action_group_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/create","name":"create","apis":[{"api_url":"/api/v1/agent_statuses","http_method":"POST","short_description":"Create Agent Status.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Hint</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\n<p>Text Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\n<p>Background Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pause_agent","full_name":"pause_agent","description":"\n<p>Translation missing: en.api.agent_statuses.pause_agent</p>\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":[]},{"name":"unpause_agent","full_name":"unpause_agent","description":"\n<p>Translation missing: en.api.agent_statuses.unpause_agent</p>\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":[]},{"name":"agent_billable","full_name":"agent_billable","description":"\n<p>Translation missing: en.api.agent_statuses.agent_billable</p>\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":[]},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\n<p>Translation missing: en.api.agent_statuses.schedule_action_group_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/show","name":"show","apis":[{"api_url":"/api/v1/agent_statuses/:id","http_method":"GET","short_description":"Get Agent Status by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/update","name":"update","apis":[{"api_url":"/api/v1/agent_statuses/:id","http_method":"PUT","short_description":"Update Agent Status by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Hint</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\n<p>Text Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\n<p>Background Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pause_agent","full_name":"pause_agent","description":"\n<p>Translation missing: en.api.agent_statuses.pause_agent</p>\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":[]},{"name":"unpause_agent","full_name":"unpause_agent","description":"\n<p>Translation missing: en.api.agent_statuses.unpause_agent</p>\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":[]},{"name":"agent_billable","full_name":"agent_billable","description":"\n<p>Translation missing: en.api.agent_statuses.agent_billable</p>\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":[]},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\n<p>Translation missing: en.api.agent_statuses.schedule_action_group_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/destroy","name":"destroy","apis":[{"api_url":"/api/v1/agent_statuses/:id","http_method":"DELETE","short_description":"Destroy Agent Status by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"agent_widgets":{"doc_url":"/api/docs/1.0/agent_widgets","id":"agent_widgets","api_url":"/api","name":"Agent Widget","short_description":"API resource for managing Agent Widget.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_widgets/show","name":"show","apis":[{"api_url":"/api/v1/agent_widgets/:id","http_method":"GET","short_description":"Get Agent Widget by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_widgets/update","name":"update","apis":[{"api_url":"/api/v1/agent_widgets/:id","http_method":"PUT","short_description":"Update Agent Widget by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_status","full_name":"system_status","description":"\n<p>Status System</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"app_configs":{"doc_url":"/api/docs/1.0/app_configs","id":"app_configs","api_url":"/api","name":"App Config","short_description":"API resource for managing App Config.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/app_configs/index","name":"index","apis":[{"api_url":"/api/v1/app_configs","http_method":"GET","short_description":"List App Config records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nvalue\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nvalue_type\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/app_configs/new","name":"new","apis":[{"api_url":"/api/v1/app_configs/new","http_method":"GET","short_description":"Build App Config with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/app_configs/create","name":"create","apis":[{"api_url":"/api/v1/app_configs","http_method":"POST","short_description":"Create App Config.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/app_configs/show","name":"show","apis":[{"api_url":"/api/v1/app_configs/:id","http_method":"GET","short_description":"Get App Config by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/app_configs/update","name":"update","apis":[{"api_url":"/api/v1/app_configs/:id","http_method":"PUT","short_description":"Update App Config by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/app_configs/destroy","name":"destroy","apis":[{"api_url":"/api/v1/app_configs/:id","http_method":"DELETE","short_description":"Destroy App Config by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"application_clusters":{"doc_url":"/api/docs/1.0/application_clusters","id":"application_clusters","api_url":"/api","name":"Application Cluster","short_description":"API resource for managing Application Cluster.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/application_clusters/index","name":"index","apis":[{"api_url":"/api/v1/application_clusters","http_method":"GET","short_description":"List Application Cluster records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nserver_role\n</li>\n<li class='column-attempt'>\nserver_category\n</li>\n<li class='column-attempt'>\naws_elb_load_balancer_arn\n</li>\n<li class='column-attempt'>\naws_elb_target_group_arn\n</li>\n<li class='column-attempt'>\nsidekiq_queues\n</li>\n<li class='column-attempt'>\ncpu_15\n</li>\n<li class='column-attempt'>\ntd_ec2_instances_count\n</li>\n<li class='column-attempt'>\nevents_sidekiq_queue\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/application_clusters/new","name":"new","apis":[{"api_url":"/api/v1/application_clusters/new","http_method":"GET","short_description":"Build Application Cluster with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/application_clusters/create","name":"create","apis":[{"api_url":"/api/v1/application_clusters","http_method":"POST","short_description":"Create Application Cluster.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/application_clusters/show","name":"show","apis":[{"api_url":"/api/v1/application_clusters/:id","http_method":"GET","short_description":"Get Application Cluster by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/application_clusters/update","name":"update","apis":[{"api_url":"/api/v1/application_clusters/:id","http_method":"PUT","short_description":"Update Application Cluster by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"bulk_csv_uploaders":{"doc_url":"/api/docs/1.0/bulk_csv_uploaders","id":"bulk_csv_uploaders","api_url":"/api","name":"Bulk Csv Uploader","short_description":"API resource for managing Bulk Csv Uploader.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/bulk_csv_uploaders/index","name":"index","apis":[{"api_url":"/api/v1/bulk_csv_uploaders","http_method":"GET","short_description":"List Bulk Csv Uploader records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\ncollaborator_id\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n<li class='column-attempt'>\ncommon_attributes\n</li>\n<li class='column-attempt'>\ncsv_text\n</li>\n<li class='column-attempt'>\nparam_name_descriptions\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/bulk_csv_uploaders/new","name":"new","apis":[{"api_url":"/api/v1/bulk_csv_uploaders/new","http_method":"GET","short_description":"Build Bulk Csv Uploader with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/bulk_csv_uploaders/create","name":"create","apis":[{"api_url":"/api/v1/bulk_csv_uploaders","http_method":"POST","short_description":"Create Bulk Csv Uploader.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/bulk_csv_uploaders/show","name":"show","apis":[{"api_url":"/api/v1/bulk_csv_uploaders/:id","http_method":"GET","short_description":"Get Bulk Csv Uploader by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/bulk_csv_uploaders/update","name":"update","apis":[{"api_url":"/api/v1/bulk_csv_uploaders/:id","http_method":"PUT","short_description":"Update Bulk Csv Uploader by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/bulk_csv_uploaders/destroy","name":"destroy","apis":[{"api_url":"/api/v1/bulk_csv_uploaders/:id","http_method":"DELETE","short_description":"Destroy Bulk Csv Uploader by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"business_ranges":{"doc_url":"/api/docs/1.0/business_ranges","id":"business_ranges","api_url":"/api","name":"Business Hours & Days","short_description":"API resources relating to business hours and days.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/business_ranges/index","name":"index","apis":[{"api_url":"/api/v1/business_ranges","http_method":"GET","short_description":"List Business Hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"owner_id","full_name":"owner_id","description":"\n<p>The ID for the record that owns this record.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\n<p>The type of record that owns this record.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\n<p>The relation.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nowner_id\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n<li class='column-attempt'>\nowner_relation\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ncolor\n</li>\n<li class='column-attempt'>\nschedule\n</li>\n<li class='column-attempt'>\nopen_times\n</li>\n<li class='column-attempt'>\nbuyer_conversion_ids\n</li>\n<li class='column-attempt'>\noffer_conversion_ids\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\ntime_zone\n</li>\n<li class='column-attempt'>\nbuyer_conversion_hourly_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_hourly_used\n</li>\n<li class='column-attempt'>\noffer_conversion_hourly_limit\n</li>\n<li class='column-attempt'>\noffer_conversion_hourly_used\n</li>\n<li class='column-attempt'>\nconnection_hourly_limit\n</li>\n<li class='column-attempt'>\nconnection_hourly_used\n</li>\n<li class='column-attempt'>\nconcurrency_limit\n</li>\n<li class='column-attempt'>\nrevenue_hourly_limit\n</li>\n<li class='column-attempt'>\nrevenue_hourly_used\n</li>\n<li class='column-attempt'>\npayout_hourly_limit\n</li>\n<li class='column-attempt'>\npayout_hourly_used\n</li>\n<li class='column-attempt'>\nattempt_hourly_limit\n</li>\n<li class='column-attempt'>\nattempt_hourly_used\n</li>\n<li class='column-attempt'>\noff_hook_concurrency_limit\n</li>\n<li class='column-attempt'>\nsoftphone_enabled\n</li>\n<li class='column-attempt'>\nday_parts\n</li>\n<li class='column-attempt'>\nbuyer_type\n</li>\n<li class='column-attempt'>\nbuyer_spacing_limit\n</li>\n<li class='column-attempt'>\nbuyer_spacing_seconds\n</li>\n<li class='column-attempt'>\nbuyer_spacing_minutes\n</li>\n<li class='column-attempt'>\nbuyer_spacing_hours\n</li>\n<li class='column-attempt'>\nbuyer_spacing_type\n</li>\n<li class='column-attempt'>\nbuyer_spacing_interval\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/new","name":"new","apis":[{"api_url":"/api/v1/business_ranges/new","http_method":"GET","short_description":"Build new business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"owner_id","full_name":"owner_id","description":"\n<p>The ID for the record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\n<p>The type of record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\n<p>The relation.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"open_times","full_name":"open_times","description":"\n<p>Define the days and hours that are open. EX:</p>\n<dl class=\"rdoc-list label-list\"><dt>{:day=&gt;0, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;1, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;2, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;3, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;4, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;5, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;6, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}\n<dd></dd></dl>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/create","name":"create","apis":[{"api_url":"/api/v1/business_ranges","http_method":"POST","short_description":"Create business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"owner_id","full_name":"owner_id","description":"\n<p>The ID for the record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\n<p>The type of record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\n<p>The relation.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"open_times","full_name":"open_times","description":"\n<p>Define the days and hours that are open. EX:</p>\n<dl class=\"rdoc-list label-list\"><dt>{:day=&gt;0, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;1, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;2, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;3, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;4, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;5, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;6, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}\n<dd></dd></dl>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/show","name":"show","apis":[{"api_url":"/api/v1/business_ranges/:id","http_method":"GET","short_description":"Show business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/update","name":"update","apis":[{"api_url":"/api/v1/business_ranges/:id","http_method":"PUT","short_description":"Update business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"open_times","full_name":"open_times","description":"\n<p>Define the days and hours that are open. EX:</p>\n<dl class=\"rdoc-list label-list\"><dt>{:day=&gt;0, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;1, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;2, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;3, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;4, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;5, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}, {:day=&gt;6, :time_from=&gt;“00:00”, :time_to=&gt;“23:59”}\n<dd></dd></dl>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/destroy","name":"destroy","apis":[{"api_url":"/api/v1/business_ranges/:id","http_method":"DELETE","short_description":"Destroy business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_conversions":{"doc_url":"/api/docs/1.0/buyer_conversions","id":"buyer_conversions","api_url":"/api","name":"Buyers: Conversions","short_description":"API resource for managing buyer conversions.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_conversions/index","name":"index","apis":[{"api_url":"/api/v1/buyer_conversions","http_method":"GET","short_description":"List buyer conversions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nowner_id\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nconversion_type\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nrevenue\n</li>\n<li class='column-attempt'>\nduration\n</li>\n<li class='column-attempt'>\nduplicate_timeframe\n</li>\n<li class='column-attempt'>\ncache_result_for_seconds\n</li>\n<li class='column-attempt'>\nbusiness_range_id\n</li>\n<li class='column-attempt'>\nrevenue_min\n</li>\n<li class='column-attempt'>\nrevenue_max\n</li>\n<li class='column-attempt'>\nrevenue_increment\n</li>\n<li class='column-attempt'>\nrevenue_type\n</li>\n<li class='column-attempt'>\nwebhook_response_success_codes\n</li>\n<li class='column-attempt'>\nwebhook_body_success_path\n</li>\n<li class='column-attempt'>\nwebhook_body_success_match\n</li>\n<li class='column-attempt'>\nwebhook_path_number\n</li>\n<li class='column-attempt'>\nwebhook_path_duration\n</li>\n<li class='column-attempt'>\nwebhook_path_name\n</li>\n<li class='column-attempt'>\nwebhook_path_revenue\n</li>\n<li class='column-attempt'>\nwebhook_type\n</li>\n<li class='column-attempt'>\nwebhook_remote_url\n</li>\n<li class='column-attempt'>\nwebhook_read_timeout\n</li>\n<li class='column-attempt'>\nwebhook_remote_method\n</li>\n<li class='column-attempt'>\nwebhook_remote_body\n</li>\n<li class='column-attempt'>\nwebhook_remote_headers\n</li>\n<li class='column-attempt'>\ntoken_value_map_ids\n</li>\n<li class='column-attempt'>\nwebhook_path_external_id\n</li>\n<li class='column-attempt'>\nwebhook_contains_many_buyers\n</li>\n<li class='column-attempt'>\nwebhook_path_buyers\n</li>\n<li class='column-attempt'>\nwebhook_response_buyers_limit\n</li>\n<li class='column-attempt'>\nwebhook_response_buyers_order_by\n</li>\n<li class='column-attempt'>\nwebhook_response_buyers_order_dir\n</li>\n<li class='column-attempt'>\noauth_connection_id\n</li>\n<li class='column-attempt'>\ncache_success_for_seconds\n</li>\n<li class='column-attempt'>\nwebhook_manual_fire_ids\n</li>\n<li class='column-attempt'>\nresponse_parser_ids\n</li>\n<li class='column-attempt'>\nwebhook_response_buyers_max_duration_fallback\n</li>\n<li class='column-attempt'>\nwebhook_response_buyers_max_duration\n</li>\n<li class='column-attempt'>\ntoken_value_map_group_ids\n</li>\n<li class='column-attempt'>\nwebhook_conversion_type\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n<li class='column-attempt'>\nwebhook_params_count\n</li>\n<li class='column-attempt'>\nbuyer_ping_parser_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/new","name":"new","apis":[{"api_url":"/api/v1/buyer_conversions/new","http_method":"GET","short_description":"Build a new buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"owner_id","full_name":"owner_id","description":"\n<p>The ID for the record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\n<p>The type of record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>This name that will appear in call logs.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"conversion_type","full_name":"conversion_type","description":"\n<p>Configure static or dynamic revenue.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>revenue</code>, <code>webhook</code>, <code>postback</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"revenue","description":"\n<p>The number of dollars paid per call in increments of $0.01 for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_min","full_name":"revenue_min","description":"\n<p>The minimum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_max","full_name":"revenue_max","description":"\n<p>The maximum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_increment","full_name":"revenue_increment","description":"\n<p>Bids must be increased/decreased by this amount for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duration","full_name":"duration","description":"\n<p>The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\n<p>The period of time that must elapse before a buyer will pay for the same caller to be transferred.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_type</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>elocal</code>, <code>media_alpha</code>, <code>marchex</code>, <code>marchex_v2</code>, <code>jornaya_tcpa_guardian</code>, <code>custom</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_url</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_method</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_body</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_headers</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n<p>How many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_limit","full_name":"webhook_response_buyers_limit","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_limit</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_by","full_name":"webhook_response_buyers_order_by","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>revenue</code>, <code>duration</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_dir","full_name":"webhook_response_buyers_order_dir","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>desc</code>, <code>asc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/create","name":"create","apis":[{"api_url":"/api/v1/buyer_conversions","http_method":"POST","short_description":"Create a buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"owner_id","full_name":"owner_id","description":"\n<p>The ID for the record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\n<p>The type of record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>This name that will appear in call logs.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"conversion_type","full_name":"conversion_type","description":"\n<p>Configure static or dynamic revenue.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>revenue</code>, <code>webhook</code>, <code>postback</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"revenue","description":"\n<p>The number of dollars paid per call in increments of $0.01 for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_min","full_name":"revenue_min","description":"\n<p>The minimum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_max","full_name":"revenue_max","description":"\n<p>The maximum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_increment","full_name":"revenue_increment","description":"\n<p>Bids must be increased/decreased by this amount for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duration","full_name":"duration","description":"\n<p>The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\n<p>The period of time that must elapse before a buyer will pay for the same caller to be transferred.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_type</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>elocal</code>, <code>media_alpha</code>, <code>marchex</code>, <code>marchex_v2</code>, <code>jornaya_tcpa_guardian</code>, <code>custom</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_url</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_method</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_body</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_headers</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n<p>How many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_limit","full_name":"webhook_response_buyers_limit","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_limit</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_by","full_name":"webhook_response_buyers_order_by","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>revenue</code>, <code>duration</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_dir","full_name":"webhook_response_buyers_order_dir","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>desc</code>, <code>asc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/show","name":"show","apis":[{"api_url":"/api/v1/buyer_conversions/:id","http_method":"GET","short_description":"Show the details of a buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/update","name":"update","apis":[{"api_url":"/api/v1/buyer_conversions/:id","http_method":"PUT","short_description":"Update a buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>This name that will appear in call logs.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"conversion_type","full_name":"conversion_type","description":"\n<p>Configure static or dynamic revenue.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>revenue</code>, <code>webhook</code>, <code>postback</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"revenue","description":"\n<p>The number of dollars paid per call in increments of $0.01 for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_min","full_name":"revenue_min","description":"\n<p>The minimum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_max","full_name":"revenue_max","description":"\n<p>The maximum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_increment","full_name":"revenue_increment","description":"\n<p>Bids must be increased/decreased by this amount for the current time frame.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duration","full_name":"duration","description":"\n<p>The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\n<p>The period of time that must elapse before a buyer will pay for the same caller to be transferred.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_type</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>elocal</code>, <code>media_alpha</code>, <code>marchex</code>, <code>marchex_v2</code>, <code>jornaya_tcpa_guardian</code>, <code>custom</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_url</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_method</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_body</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_remote_headers</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n<p>How many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_limit","full_name":"webhook_response_buyers_limit","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_limit</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_by","full_name":"webhook_response_buyers_order_by","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>revenue</code>, <code>duration</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_dir","full_name":"webhook_response_buyers_order_dir","description":"\n<p>Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>desc</code>, <code>asc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_conversions/:id","http_method":"DELETE","short_description":"Delete a buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_groups":{"doc_url":"/api/docs/1.0/buyer_groups","id":"buyer_groups","api_url":"/api","name":"Buyer Groups","short_description":"The buyer groups in your account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_groups/index","name":"index","apis":[{"api_url":"/api/v1/buyer_groups","http_method":"GET","short_description":"Get buyer groups.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nconcurrency_cap_limit\n</li>\n<li class='column-attempt'>\nconcurrency_cap_used\n</li>\n<li class='column-attempt'>\nbuyer_ids\n</li>\n<li class='column-attempt'>\nbuyers_count\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nmaxed_out\n</li>\n<li class='column-attempt'>\nweight\n</li>\n<li class='column-attempt'>\ntier\n</li>\n<li class='column-attempt'>\ntime_zone\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\npaused_at\n</li>\n<li class='column-attempt'>\npaused_by_user_id\n</li>\n<li class='column-attempt'>\nunpaused_at\n</li>\n<li class='column-attempt'>\ndial_buyers_type\n</li>\n<li class='column-attempt'>\nattempt_daily_used\n</li>\n<li class='column-attempt'>\nattempt_hourly_used\n</li>\n<li class='column-attempt'>\nattempt_monthly_used\n</li>\n<li class='column-attempt'>\nattempt_total_used\n</li>\n<li class='column-attempt'>\nbuyer_conversion_daily_used\n</li>\n<li class='column-attempt'>\nbuyer_conversion_hourly_used\n</li>\n<li class='column-attempt'>\nbuyer_conversion_monthly_used\n</li>\n<li class='column-attempt'>\nbuyer_conversion_total_used\n</li>\n<li class='column-attempt'>\nconnection_daily_used\n</li>\n<li class='column-attempt'>\nconnection_hourly_used\n</li>\n<li class='column-attempt'>\nconnection_monthly_used\n</li>\n<li class='column-attempt'>\nconnection_total_used\n</li>\n<li class='column-attempt'>\nearned_revenue_daily_used\n</li>\n<li class='column-attempt'>\nearned_revenue_hourly_used\n</li>\n<li class='column-attempt'>\nearned_revenue_monthly_used\n</li>\n<li class='column-attempt'>\nearned_revenue_total_used\n</li>\n<li class='column-attempt'>\nrevenue_daily_used\n</li>\n<li class='column-attempt'>\nrevenue_hourly_used\n</li>\n<li class='column-attempt'>\nrevenue_monthly_used\n</li>\n<li class='column-attempt'>\nrevenue_total_used\n</li>\n<li class='column-attempt'>\nattempt_daily_limit\n</li>\n<li class='column-attempt'>\nattempt_hourly_limit\n</li>\n<li class='column-attempt'>\nattempt_monthly_limit\n</li>\n<li class='column-attempt'>\nattempt_total_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_daily_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_hourly_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_monthly_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_total_limit\n</li>\n<li class='column-attempt'>\nconnection_daily_limit\n</li>\n<li class='column-attempt'>\nconnection_hourly_limit\n</li>\n<li class='column-attempt'>\nconnection_monthly_limit\n</li>\n<li class='column-attempt'>\nconnection_total_limit\n</li>\n<li class='column-attempt'>\nearned_revenue_daily_limit\n</li>\n<li class='column-attempt'>\nearned_revenue_hourly_limit\n</li>\n<li class='column-attempt'>\nearned_revenue_monthly_limit\n</li>\n<li class='column-attempt'>\nearned_revenue_total_limit\n</li>\n<li class='column-attempt'>\nrevenue_daily_limit\n</li>\n<li class='column-attempt'>\nrevenue_hourly_limit\n</li>\n<li class='column-attempt'>\nrevenue_monthly_limit\n</li>\n<li class='column-attempt'>\nrevenue_total_limit\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]},{"name":"order","full_name":"order","description":"\n<p>Sort results by this field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>name</code>, <code>maxed_out</code>, <code>weight</code>, <code>tier</code>, <code>cap_reset_at</code>, <code>time_zone</code>, <code>created_at</code>, <code>updated_at</code>, <code>paused</code>, <code>paused_at</code>, <code>paused_by_user_id</code>, <code>unpaused_at</code>, <code>user_updated_at</code>, <code>dial_buyers_type</code>, <code>call_limits.in_progress_count</code>, <code>call_limits.in_progress_used</code>, <code>call_limits.revenue_hourly_used</code>, <code>call_limits.revenue_daily_used</code>, <code>call_limits.revenue_monthly_used</code>, <code>call_limits.revenue_total_used</code>, <code>call_limits.earned_revenue_hourly_used</code>, <code>call_limits.earned_revenue_daily_used</code>, <code>call_limits.earned_revenue_monthly_used</code>, <code>call_limits.earned_revenue_total_used</code>, <code>call_limits.buyer_conversion_hourly_used</code>, <code>call_limits.buyer_conversion_daily_used</code>, <code>call_limits.buyer_conversion_monthly_used</code>, <code>call_limits.buyer_conversion_total_used</code>, <code>call_limits.connection_hourly_used</code>, <code>call_limits.connection_daily_used</code>, <code>call_limits.connection_monthly_used</code>, <code>call_limits.connection_total_used</code>, <code>call_limits.attempt_hourly_used</code>, <code>call_limits.attempt_daily_used</code>, <code>call_limits.attempt_monthly_used</code>, <code>call_limits.attempt_total_used</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_dir","full_name":"order_dir","description":"\n<p>Sort results in ascending or descending order.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>desc</code>, <code>asc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/buyer_groups?page=1&order=created_at&\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_groups/show","name":"show","apis":[{"api_url":"/api/v1/buyer_groups/:id","http_method":"GET","short_description":"Get an individual buyer group by id","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_groups/create","name":"create","apis":[{"api_url":"/api/v1/buyer_groups/:id","http_method":"POST","short_description":"Update an individual buyer group","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>The name of the buyer group.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Pause or unpause.</p>\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":[]},{"name":"reset_total_caps","full_name":"reset_total_caps","description":"\n<p>Send <code>true</code> to reset the total caps on this buyer group.</p>\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":[]},{"name":"dial_buyers_type","full_name":"dial_buyers_type","description":"\n<p>Configure the dial buyer behaviour.<br> <code>sequentially</code> will dial one buyer a time.<br> <code>simultaneously</code> will dial all buyers in the group at the same time.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>sequentially</code>, <code>simultaneously</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>The list of buyer ids that will be dialed.<br> Example: <code>[100123, 100124, 1000125]</code> Obtain internal buyer IDs by making a request to <code>/api/v1/buyers?columns=name,id,user_buyer_id</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tier","full_name":"tier","description":"\n<p>When <code>dial_buyers_type</code> is set to <code>simultaneously</code>, the buyer group will become prioritized by tier and weight.<br> Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).<br> For buyers/buyer groups with the same tier, the weight will then be used to calculate the % of calls the buyer/buyer group gets within that tier.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"weight","description":"\n<p>When <code>dial_buyers_type</code> is set to <code>simultaneously</code>, the buyer group will become prioritized by tier and weight.<br> The Weight of this buyer group will be divided by the Total Weight of all buyers/buyer groups at this same Tier to get the % of calls this buyer/buyer group will get within this Tier.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_team","full_name":"generate_team","description":"\n<p>Grant access to manage this buyer group, it&#39;s buyers, and to view calls that it&#39;s paid for.</p>\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":[]},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n<p>The selected users will recieve an email invitation to collaborate on your company.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: <code>[\"john-smith@gmail.com\", \"example@domain.com\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n<p>Team members can view calls made to these Offers that were paid for by the buyers in this group.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_total_limit","full_name":"attempt_total_limit","description":"\n<p>Attempt caps limit the number of times a buyer can be attempted in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_monthly_limit","full_name":"attempt_monthly_limit","description":"\n<p>Monthly Attempt Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_daily_limit","full_name":"attempt_daily_limit","description":"\n<p>Daily Attempt Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_total_limit","full_name":"connection_total_limit","description":"\n<p>Connection caps limit the number of times a buyer can be connected in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_monthly_limit","full_name":"connection_monthly_limit","description":"\n<p>Monthly Connection Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_daily_limit","full_name":"connection_daily_limit","description":"\n<p>Daily Connection Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_total_limit","full_name":"buyer_conversion_total_limit","description":"\n<p>Conversion caps limit the number of times a buyer can convert in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_monthly_limit","full_name":"buyer_conversion_monthly_limit","description":"\n<p>Monthly Conversion Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_daily_limit","full_name":"buyer_conversion_daily_limit","description":"\n<p>Daily Conversion Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_total_limit","full_name":"revenue_total_limit","description":"\n<p>Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_monthly_limit","full_name":"revenue_monthly_limit","description":"\n<p>Monthly $ Revenue Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_daily_limit","full_name":"revenue_daily_limit","description":"\n<p>Daily $ Revenue Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"name \":\"Great Group Of Buyers\", \"buyer_ids\": [100123,100124]}' https://[your-subdomain].trackdrive.com/api/v1/buyer_groups"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_groups/update","name":"update","apis":[{"api_url":"/api/v1/buyer_groups/:id","http_method":"PUT","short_description":"Update an individual buyer group","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"paused","full_name":"paused","description":"\n<p>Pause or unpause.</p>\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":[]},{"name":"name","full_name":"name","description":"\n<p>The name of the buyer group.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reset_total_caps","full_name":"reset_total_caps","description":"\n<p>Send <code>true</code> to reset the total caps on this buyer group.</p>\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":[]},{"name":"dial_buyers_type","full_name":"dial_buyers_type","description":"\n<p>Configure the dial buyer behaviour.<br> <code>sequentially</code> will dial one buyer a time.<br> <code>simultaneously</code> will dial all buyers in the group at the same time.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>sequentially</code>, <code>simultaneously</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\n<p>Append buyers to this record.<br> For example pass: <code>[100123,100124]</code> in order to append 100123, and 100124 to the list of buyers in the record.<br> &lt;strong&gt;This is useful when making parallel PUT requests with different add_buyer_ids or remove_buyer_ids values. These add/remove assignments are thread safe.&lt;/strong&gt;</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove_buyer_ids","full_name":"remove_buyer_ids","description":"\n<p>Remove buyers from the record.<br> For example pass: <code>[100123]</code> in order to delete 100123 from the list of buyers in the record.<br></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"add_user_buyer_ids","full_name":"add_user_buyer_ids","description":"\n<p>Append buyers to the record using the buyer field <code>user_buyer_id</code><br> For example pass: <code>[&quot;loan-22-en&quot;, &quot;loan-23-fr&quot;]</code><br></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\n<p>Remove buyers from the record using buyer field <code>user_buyer_id</code><br> For example pass: <code>[&quot;loan-23-fr&quot;]</code><br></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>The list of buyer ids that will be dialed.<br> Example: <code>[100123, 100124, 1000125]</code> Obtain internal buyer IDs by making a request to <code>/api/v1/buyers?columns=name,id,user_buyer_id</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tier","full_name":"tier","description":"\n<p>When <code>dial_buyers_type</code> is set to <code>simultaneously</code>, the buyer group will become prioritized by tier and weight.<br> Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).<br> For buyers/buyer groups with the same tier, the weight will then be used to calculate the % of calls the buyer/buyer group gets within that tier.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"weight","description":"\n<p>When <code>dial_buyers_type</code> is set to <code>simultaneously</code>, the buyer group will become prioritized by tier and weight.<br> The Weight of this buyer group will be divided by the Total Weight of all buyers/buyer groups at this same Tier to get the % of calls this buyer/buyer group will get within this Tier.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_team","full_name":"generate_team","description":"\n<p>Grant access to manage this buyer group, it&#39;s buyers, and to view calls that it&#39;s paid for.</p>\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":[]},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n<p>The selected users will recieve an email invitation to collaborate on your company.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: <code>[\"john-smith@gmail.com\", \"example@domain.com\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n<p>Team members can view calls made to these Offers that were paid for by the buyers in this group.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_total_limit","full_name":"attempt_total_limit","description":"\n<p>Attempt caps limit the number of times a buyer can be attempted in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_monthly_limit","full_name":"attempt_monthly_limit","description":"\n<p>Monthly Attempt Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_daily_limit","full_name":"attempt_daily_limit","description":"\n<p>Daily Attempt Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_total_limit","full_name":"connection_total_limit","description":"\n<p>Connection caps limit the number of times a buyer can be connected in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_monthly_limit","full_name":"connection_monthly_limit","description":"\n<p>Monthly Connection Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_daily_limit","full_name":"connection_daily_limit","description":"\n<p>Daily Connection Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_total_limit","full_name":"buyer_conversion_total_limit","description":"\n<p>Conversion caps limit the number of times a buyer can convert in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_monthly_limit","full_name":"buyer_conversion_monthly_limit","description":"\n<p>Monthly Conversion Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_daily_limit","full_name":"buyer_conversion_daily_limit","description":"\n<p>Daily Conversion Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_total_limit","full_name":"revenue_total_limit","description":"\n<p>Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_monthly_limit","full_name":"revenue_monthly_limit","description":"\n<p>Monthly $ Revenue Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_daily_limit","full_name":"revenue_daily_limit","description":"\n<p>Daily $ Revenue Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"name \":\"Great Group Of Buyers\", \"add_buyer_ids\": [100123,100124], \"remove_buyer_ids\": [100101]}' https://[your-subdomain].trackdrive.com/api/v1/buyer_groups/123456"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_groups/:id","http_method":"DELETE","short_description":"Destroy an individual buyer group.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE https://[your-subdomain].trackdrive.com/api/v1/buyer_groups/:id"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_ping_parser_paths":{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths","id":"buyer_ping_parser_paths","api_url":"/api","name":"Parsing Path","short_description":"API resource for managing Parsing Path.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/index","name":"index","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths","http_method":"GET","short_description":"List Parsing Path records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nbuyer_ping_parser_id\n</li>\n<li class='column-attempt'>\nvalue_path\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nvalue_formatter\n</li>\n<li class='column-attempt'>\nvalue_type\n</li>\n<li class='column-attempt'>\nvalue_expression\n</li>\n<li class='column-attempt'>\nassign_value_to_token\n</li>\n<li class='column-attempt'>\nassign_to_token_key\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/new","name":"new","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths/new","http_method":"GET","short_description":"Build Parsing Path with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"buyer_ping_parser_id","full_name":"buyer_ping_parser_id","description":"\n<p>Buyer Ping Parser</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\n<p>Value Path</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/create","name":"create","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths","http_method":"POST","short_description":"Create Parsing Path.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"buyer_ping_parser_id","full_name":"buyer_ping_parser_id","description":"\n<p>Buyer Ping Parser</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\n<p>Value Path</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/show","name":"show","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths/:id","http_method":"GET","short_description":"Get Parsing Path by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/update","name":"update","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths/:id","http_method":"PUT","short_description":"Update Parsing Path by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"buyer_ping_parser_id","full_name":"buyer_ping_parser_id","description":"\n<p>Buyer Ping Parser</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\n<p>Value Path</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths/:id","http_method":"DELETE","short_description":"Destroy Parsing Path by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_ping_parsers":{"doc_url":"/api/docs/1.0/buyer_ping_parsers","id":"buyer_ping_parsers","api_url":"/api","name":"Extract Custom Buyer Attribute","short_description":"API resource for managing Extract Custom Buyer Attribute.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_ping_parsers/index","name":"index","apis":[{"api_url":"/api/v1/buyer_ping_parsers","http_method":"GET","short_description":"List Extract Custom Buyer Attribute records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nbuyer_ping_parser_paths_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/new","name":"new","apis":[{"api_url":"/api/v1/buyer_ping_parsers/new","http_method":"GET","short_description":"Build Extract Custom Buyer Attribute with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/create","name":"create","apis":[{"api_url":"/api/v1/buyer_ping_parsers","http_method":"POST","short_description":"Create Extract Custom Buyer Attribute.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/show","name":"show","apis":[{"api_url":"/api/v1/buyer_ping_parsers/:id","http_method":"GET","short_description":"Get Extract Custom Buyer Attribute by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/update","name":"update","apis":[{"api_url":"/api/v1/buyer_ping_parsers/:id","http_method":"PUT","short_description":"Update Extract Custom Buyer Attribute by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_ping_parsers/:id","http_method":"DELETE","short_description":"Destroy Extract Custom Buyer Attribute by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_suppression_files":{"doc_url":"/api/docs/1.0/buyer_suppression_files","id":"buyer_suppression_files","api_url":"/api","name":"Suppression File","short_description":"API resource for managing Suppression File.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_suppression_files/index","name":"index","apis":[{"api_url":"/api/v1/buyer_suppression_files","http_method":"GET","short_description":"List Suppression File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nbuyer_suppression_id\n</li>\n<li class='column-attempt'>\napply_block_or_unblock\n</li>\n<li class='column-attempt'>\nimport_file_url\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\ncaller_id_column_name\n</li>\n<li class='column-attempt'>\nerror_message\n</li>\n<li class='column-attempt'>\nimport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nstopped_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nheaders\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppression_files/new","name":"new","apis":[{"api_url":"/api/v1/buyer_suppression_files/new","http_method":"GET","short_description":"Build Suppression File with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n<p>Buyer Suppression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Suppression}[/api/docs/1.0/buyer_suppressions/index.html]. Refer to: {/api/docs/1.0/buyer_suppressions}[/api/docs/1.0/buyer_suppressions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n<p>Apply Block Or Unblock</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n<p>Caller Id Column Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppression_files/create","name":"create","apis":[{"api_url":"/api/v1/buyer_suppression_files","http_method":"POST","short_description":"Create Suppression File.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n<p>Buyer Suppression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Suppression}[/api/docs/1.0/buyer_suppressions/index.html]. Refer to: {/api/docs/1.0/buyer_suppressions}[/api/docs/1.0/buyer_suppressions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n<p>Apply Block Or Unblock</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n<p>Caller Id Column Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppression_files/show","name":"show","apis":[{"api_url":"/api/v1/buyer_suppression_files/:id","http_method":"GET","short_description":"Get Suppression File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppression_files/update","name":"update","apis":[{"api_url":"/api/v1/buyer_suppression_files/:id","http_method":"PUT","short_description":"Update Suppression File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n<p>Buyer Suppression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Suppression}[/api/docs/1.0/buyer_suppressions/index.html]. Refer to: {/api/docs/1.0/buyer_suppressions}[/api/docs/1.0/buyer_suppressions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n<p>Apply Block Or Unblock</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n<p>Caller Id Column Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_suppressions_contacts":{"doc_url":"/api/docs/1.0/buyer_suppressions_contacts","id":"buyer_suppressions_contacts","api_url":"/api","name":"Buyer Suppression Caller","short_description":"API resource for managing Buyer Suppression Caller.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_suppressions_contacts/index","name":"index","apis":[{"api_url":"/api/v1/buyer_suppressions_contacts","http_method":"GET","short_description":"List Buyer Suppression Caller records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_suppressions":{"doc_url":"/api/docs/1.0/buyer_suppressions","id":"buyer_suppressions","api_url":"/api","name":"Suppression Lists","short_description":"API resource for managing suppression lists on offers, schedules, and buyers.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_suppressions/index","name":"index","apis":[{"api_url":"/api/v1/buyer_suppressions","http_method":"GET","short_description":"List suppression lists.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nimport_file_url\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\ncaller_id_column_name\n</li>\n<li class='column-attempt'>\nheaders\n</li>\n<li class='column-attempt'>\nblocked\n</li>\n<li class='column-attempt'>\nerror_message\n</li>\n<li class='column-attempt'>\nimport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\nimport_percent\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nstopped_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nbuyer_ids\n</li>\n<li class='column-attempt'>\noffer_ids\n</li>\n<li class='column-attempt'>\nschedule_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/new","name":"new","apis":[{"api_url":"/api/v1/buyer_suppressions/new","http_method":"GET","short_description":"Build suppression list with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n<p>Caller Id Column Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>The list of internal buyer ID&#39;s that will use this suppression list.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/create","name":"create","apis":[{"api_url":"/api/v1/buyer_suppressions","http_method":"POST","short_description":"Create suppression list.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n<p>Caller Id Column Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>The list of internal buyer ID&#39;s that will use this suppression list.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/show","name":"show","apis":[{"api_url":"/api/v1/buyer_suppressions/:id","http_method":"GET","short_description":"Get suppression list by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/update","name":"update","apis":[{"api_url":"/api/v1/buyer_suppressions/:id","http_method":"PUT","short_description":"Update suppression list by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n<p>Caller Id Column Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>The list of internal buyer ID&#39;s that will use this suppression list.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\n<p>Append buyers to this record.<br> For example pass: <code>[100123,100124]</code> in order to append 100123, and 100124 to the list of buyers in the record.<br> &lt;strong&gt;This is useful when making parallel PUT requests with different add_buyer_ids or remove_buyer_ids values. These add/remove assignments are thread safe.&lt;/strong&gt;</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove_buyer_ids","full_name":"remove_buyer_ids","description":"\n<p>Remove buyers from the record.<br> For example pass: <code>[100123]</code> in order to delete 100123 from the list of buyers in the record.<br></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"add_user_buyer_ids","full_name":"add_user_buyer_ids","description":"\n<p>Append buyers to the record using the buyer field <code>user_buyer_id</code><br> For example pass: <code>[&quot;loan-22-en&quot;, &quot;loan-23-fr&quot;]</code><br></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\n<p>Remove buyers from the record using buyer field <code>user_buyer_id</code><br> For example pass: <code>[&quot;loan-23-fr&quot;]</code><br></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_suppressions/:id","http_method":"DELETE","short_description":"Destroy suppression list by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/caller_block","name":"caller_block","apis":[{"api_url":"/api/v1/buyer_suppressions/:id/caller_block","http_method":"POST","short_description":"Add individual phone numbers to a suppression list.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_ids","full_name":"caller_ids","description":"\n<p>An array of phone numbers to block.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Content-Type: application/json\" -X POST -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -d '{\"caller_ids\": [\"17191231234\",\"17191231235\"]}' \"https://[your-subdomain].trackdrive.com/api/v1/buyer_suppressions/:id/caller_block\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/caller_unblock","name":"caller_unblock","apis":[{"api_url":"/api/v1/buyer_suppressions/:id/caller_unblock","http_method":"POST","short_description":"Remove individual phone numbers from a suppression list.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_ids","full_name":"caller_ids","description":"\n<p>An array of phone numbers to block.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Content-Type: application/json\" -X POST -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -d '{\"caller_ids\": [\"17191231234\",\"17191231235\"]}' \"https://[your-subdomain].trackdrive.com/api/v1/buyer_suppressions/:id/caller_unblock\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyers":{"doc_url":"/api/docs/1.0/buyers","id":"buyers","api_url":"/api","name":"Buyers","short_description":"The buyers in your account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyers/index","name":"index","apis":[{"api_url":"/api/v1/buyers","http_method":"GET","short_description":"Get buyers.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>buyer</th><td>Default response format.</td></tr><tr><th>buyer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number","full_name":"number","description":"\n<p>Filter buyers for a telephone number.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Filter buyers that are either paused or unpaused.</p>\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":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nemail\n</li>\n<li class='column-attempt'>\nnumber\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\ntime_zone\n</li>\n<li class='column-attempt'>\nuser_buyer_id\n</li>\n<li class='column-attempt'>\nbid_price\n</li>\n<li class='column-attempt'>\nroute_by_type\n</li>\n<li class='column-attempt'>\nbuyer_type\n</li>\n<li class='column-attempt'>\nbuyer_group_ids\n</li>\n<li class='column-attempt'>\nbuyer_group_names\n</li>\n<li class='column-attempt'>\ntoken_values\n</li>\n<li class='column-attempt'>\ntoken_values_hash\n</li>\n<li class='column-attempt'>\nattribution_token_values\n</li>\n<li class='column-attempt'>\nattribution_token_values_hash\n</li>\n<li class='column-attempt'>\nlast_call_at\n</li>\n<li class='column-attempt'>\nweight\n</li>\n<li class='column-attempt'>\ntier\n</li>\n<li class='column-attempt'>\ntimeout_seconds\n</li>\n<li class='column-attempt'>\ndtmf_tones\n</li>\n<li class='column-attempt'>\nconcurrency_cap_limit\n</li>\n<li class='column-attempt'>\nconcurrency_cap_used\n</li>\n<li class='column-attempt'>\nmaxed_out_by\n</li>\n<li class='column-attempt'>\ncurrent_conversion_revenue_max\n</li>\n<li class='column-attempt'>\ncurrent_conversion_revenue_min\n</li>\n<li class='column-attempt'>\ncurrent_conversion_revenue_increment\n</li>\n<li class='column-attempt'>\ncurrent_conversion_revenue\n</li>\n<li class='column-attempt'>\ncurrent_conversion_duration\n</li>\n<li class='column-attempt'>\ncurrent_conversion_duplicate_timeframe\n</li>\n<li class='column-attempt'>\ncurrent_conversion_name\n</li>\n<li class='column-attempt'>\ncurrent_conversion_token_value_ids\n</li>\n<li class='column-attempt'>\ncurrent_conversion_attribution_token_value_ids\n</li>\n<li class='column-attempt'>\nbuyer_suppression_ids\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n<li class='column-attempt'>\nattempt_daily_used\n</li>\n<li class='column-attempt'>\nattempt_hourly_used\n</li>\n<li class='column-attempt'>\nattempt_monthly_used\n</li>\n<li class='column-attempt'>\nattempt_total_used\n</li>\n<li class='column-attempt'>\nbuyer_conversion_daily_used\n</li>\n<li class='column-attempt'>\nbuyer_conversion_hourly_used\n</li>\n<li class='column-attempt'>\nbuyer_conversion_monthly_used\n</li>\n<li class='column-attempt'>\nbuyer_conversion_total_used\n</li>\n<li class='column-attempt'>\nconnection_daily_used\n</li>\n<li class='column-attempt'>\nconnection_hourly_used\n</li>\n<li class='column-attempt'>\nconnection_monthly_used\n</li>\n<li class='column-attempt'>\nconnection_total_used\n</li>\n<li class='column-attempt'>\nearned_revenue_daily_used\n</li>\n<li class='column-attempt'>\nearned_revenue_hourly_used\n</li>\n<li class='column-attempt'>\nearned_revenue_monthly_used\n</li>\n<li class='column-attempt'>\nearned_revenue_total_used\n</li>\n<li class='column-attempt'>\nrevenue_daily_used\n</li>\n<li class='column-attempt'>\nrevenue_hourly_used\n</li>\n<li class='column-attempt'>\nrevenue_monthly_used\n</li>\n<li class='column-attempt'>\nrevenue_total_used\n</li>\n<li class='column-attempt'>\nattempt_daily_limit\n</li>\n<li class='column-attempt'>\nattempt_hourly_limit\n</li>\n<li class='column-attempt'>\nattempt_monthly_limit\n</li>\n<li class='column-attempt'>\nattempt_total_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_daily_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_hourly_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_monthly_limit\n</li>\n<li class='column-attempt'>\nbuyer_conversion_total_limit\n</li>\n<li class='column-attempt'>\nconnection_daily_limit\n</li>\n<li class='column-attempt'>\nconnection_hourly_limit\n</li>\n<li class='column-attempt'>\nconnection_monthly_limit\n</li>\n<li class='column-attempt'>\nconnection_total_limit\n</li>\n<li class='column-attempt'>\nearned_revenue_daily_limit\n</li>\n<li class='column-attempt'>\nearned_revenue_hourly_limit\n</li>\n<li class='column-attempt'>\nearned_revenue_monthly_limit\n</li>\n<li class='column-attempt'>\nearned_revenue_total_limit\n</li>\n<li class='column-attempt'>\nrevenue_daily_limit\n</li>\n<li class='column-attempt'>\nrevenue_hourly_limit\n</li>\n<li class='column-attempt'>\nrevenue_monthly_limit\n</li>\n<li class='column-attempt'>\nrevenue_total_limit\n</li>\n<li class='column-attempt'>\nbusiness_hours_schedule\n</li>\n<li class='column-attempt'>\nbuyer_conversions_schedule\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]},{"name":"order","full_name":"order","description":"\n<p>Sort results by this field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>id</code>, <code>name</code>, <code>calls_count</code>, <code>recent_calls_count</code>, <code>outgoing_webhooks_count</code>, <code>paused</code>, <code>number</code>, <code>created_at</code>, <code>last_call_at</code>, <code>tier</code>, <code>weight</code>, <code>time_zone</code>, <code>user_buyer_id</code>, <code>revenue_hourly_used</code>, <code>revenue_daily_used</code>, <code>revenue_monthly_used</code>, <code>revenue_total_used</code>, <code>earned_revenue_hourly_used</code>, <code>earned_revenue_daily_used</code>, <code>earned_revenue_monthly_used</code>, <code>earned_revenue_total_used</code>, <code>buyer_conversion_hourly_used</code>, <code>buyer_conversion_daily_used</code>, <code>buyer_conversion_monthly_used</code>, <code>buyer_conversion_total_used</code>, <code>connection_hourly_used</code>, <code>connection_daily_used</code>, <code>connection_monthly_used</code>, <code>connection_total_used</code>, <code>attempt_hourly_used</code>, <code>attempt_daily_used</code>, <code>attempt_monthly_used</code>, <code>attempt_total_used</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_dir","full_name":"order_dir","description":"\n<p>Sort results in ascending or descending order.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>desc</code>, <code>asc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" https://[your-subdomain].trackdrive.com/api/v1/buyers"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/show","name":"show","apis":[{"api_url":"/api/v1/buyers/:id","http_method":"GET","short_description":"Get an individual buyer by id","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>buyer</th><td>Default response format.</td></tr><tr><th>buyer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/show_by_user_buyer_id","name":"show_by_user_buyer_id","apis":[{"api_url":"/api/v1/buyers/:user_buyer_id/by_user_buyer_id","http_method":"GET","short_description":"Get a buyer record by your own external ID for the buyer.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>buyer</th><td>Default response format.</td></tr><tr><th>buyer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/update","name":"update","apis":[{"api_url":"/api/v1/buyers/:id","http_method":"PUT","short_description":"Update an individual buyer","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>buyer</th><td>Default response format.</td></tr><tr><th>buyer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reset_total_caps","full_name":"reset_total_caps","description":"","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":[]},{"name":"user_buyer_id","full_name":"user_buyer_id","description":"\n<p>Your external ID for this buyer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number","full_name":"number","description":"\n<p>The DID or SIP endpoint to call. DID must be prefixed with +{country code}.  Example: to dial a number in the USA, enter +1 followed by the 10 digit DID number, in UK it would be +44 followed by the DID number.  To transfer a call via SIP, begin the number with &#39;sip:&#39;.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>The name for this buyer that will appear on menus and in logs.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timeout_seconds","full_name":"timeout_seconds","description":"\n<p>Determines the time in seconds the call should ring. Must be at least 12 seconds. If the call is not answered within the ring timeout value or the default value of 120 s, it is canceled.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dtmf_tones","full_name":"dtmf_tones","description":"\n<p>Play DTMF tones when the call is answered. This is useful when dialing a phone number and an extension. Your provider will dial the number, and when the automated system picks up, sends the DTMF tones to connect to the extension. E.g. If you want to dial the 2410 extension after the call is connected, and you want to wait for a few seconds before sending the extension, add a few leading &#39;w&#39; characters. Each &#39;w&#39; character waits 0.5 second before sending a digit. Each &#39;W&#39; character waits 1 second before sending a digit.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"name":"buyer_suppression_ids","full_name":"buyer_suppression_ids","description":"\n<p>The list of internal suppression id&#39;s that will be assigned to this buyer.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Suppression}[/api/docs/1.0/buyer_suppressions/index.html]. Refer to: {/api/docs/1.0/buyer_suppressions}[/api/docs/1.0/buyer_suppressions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Pause or unpause the buyer.</p>\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":[]},{"name":"record_calls","full_name":"record_calls","description":"\n<p>Enable or Disable call recordings for this Buyer.</p>\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":[]},{"name":"press_one_to_accept","full_name":"press_one_to_accept","description":"\n<p>After answering the call the Buyer must Press 1 before being connected to the Caller.<br> Trackdrive will use the “Press 1 To Accept” call routing from the current Offer.</p>\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":[]},{"name":"generate_team","full_name":"generate_team","description":"\n<p>Grant access to edit this Buyer, and view calls that it paid for.</p>\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":[]},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n<p>The selected users will recieve an email invitation to collaborate on your company.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: <code>[\"john-smith@gmail.com\", \"example@domain.com\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n<p>Team members can view calls made to these Offers that were paid for by their Buyer.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"route_by_type","full_name":"route_by_type","description":"\n<p>Configure how calls will be routed to this Buyer. When routing by revenue the tier will be automatically calculated by taking the revenue for the current timeframe * -1.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>tier</code>, <code>revenue</code>, <code>epc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tier","full_name":"tier","description":"\n<p>When routing by revenue the tier will not be used. Buyers with the lowest tier are considered first for calls (a tier may be negative if needed).  For buyers with the same tier, the weight will then be used to calculate the % of calls the buyer gets within that tier.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"epc_timeframe","full_name":"epc_timeframe","description":"\n<p>The number of hours used when calculating the <code>EPC</code>. If there are less than <code>Minimum Required Calls</code> in this timeframe the <code>Assumed EPC</code> will be used instead.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"epc_assumed_amount","full_name":"epc_assumed_amount","description":"\n<p>The <code>Assumed EPC</code> will be used until the Buyer has received <code>Minimum Required Calls</code> calls during the <code>EPC Timeframe</code>.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"epc_assumed_calls_count","full_name":"epc_assumed_calls_count","description":"\n<p>The number of calls required during <code>EPC Timeframe</code> before the real <code>EPC</code> is used insead of the <code>Assumed EPC</code>.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"weight","description":"\n<p>The Weight of this buyer will be divided by the Total Weight of all buyers at this same Tier to get the % of calls this buyer will get within this Tier.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"display_caller_id_type","full_name":"display_caller_id_type","description":"\n<p>Select which Caller ID will be sent to this Buyer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>display_caller_id</code>, <code>display_fake_caller_id</code>, <code>display_trackdrive_number_id</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"display_trackdrive_number_id","full_name":"display_trackdrive_number_id","description":"\n<p>The Trackdrive number to display when display_caller_id_type=display_trackdrive_number_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number}[/api/docs/1.0/phone_numbers/index.html]. Refer to: {/api/docs/1.0/phone_numbers}[/api/docs/1.0/phone_numbers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"concurrency_cap_limit","full_name":"concurrency_cap_limit","description":"\n<p>Choose the number of concurrent calls that can be forwarded to this buyer simultaneously.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_total_limit","full_name":"attempt_total_limit","description":"\n<p>Attempt caps limit the number of times a buyer can be attempted in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_monthly_limit","full_name":"attempt_monthly_limit","description":"\n<p>Monthly Attempt Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_daily_limit","full_name":"attempt_daily_limit","description":"\n<p>Daily Attempt Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_total_limit","full_name":"connection_total_limit","description":"\n<p>Connection caps limit the number of times a buyer can be connected in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_monthly_limit","full_name":"connection_monthly_limit","description":"\n<p>Monthly Connection Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_daily_limit","full_name":"connection_daily_limit","description":"\n<p>Daily Connection Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_total_limit","full_name":"buyer_conversion_total_limit","description":"\n<p>Conversion caps limit the number of times a buyer can convert in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_monthly_limit","full_name":"buyer_conversion_monthly_limit","description":"\n<p>Monthly Conversion Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_daily_limit","full_name":"buyer_conversion_daily_limit","description":"\n<p>Daily Conversion Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_total_limit","full_name":"revenue_total_limit","description":"\n<p>Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_monthly_limit","full_name":"revenue_monthly_limit","description":"\n<p>Monthly $ Revenue Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_daily_limit","full_name":"revenue_daily_limit","description":"\n<p>Daily $ Revenue Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_hours_schedule","full_name":"business_hours_schedule","description":"\n<p>Day is an integer representing the day of the week, 0..6, with Sunday == 0. [</p>\n\n<pre class=\"ruby\">{\n  <span class=\"ruby-value\">attempt_hourly_limit:</span> <span class=\"ruby-value\">10</span>,\n  <span class=\"ruby-value\">connection_hourly_limit:</span> <span class=\"ruby-value\">10</span>,\n  <span class=\"ruby-value\">buyer_conversion_hourly_limit:</span> <span class=\"ruby-value\">10</span>,\n  <span class=\"ruby-value\">revenue_hourly_limit:</span> <span class=\"ruby-value\">10</span>,\n  <span class=\"ruby-value\">schedule:</span> [\n    {\n      <span class=\"ruby-value\">day:</span> <span class=\"ruby-value\">0</span>,\n      <span class=\"ruby-value\">times:</span> [<span class=\"ruby-string\">&quot;11:00..13:09&quot;</span>, <span class=\"ruby-string\">&quot;14:00..15:09&quot;</span>]\n    },\n    {\n      <span class=\"ruby-value\">day:</span> <span class=\"ruby-value\">1</span>,\n      <span class=\"ruby-value\">times:</span> [<span class=\"ruby-string\">&quot;11:10..18:39&quot;</span>, <span class=\"ruby-string\">&quot;19:10..23:39&quot;</span>]\n    }\n  ]\n}\n</pre>\n\n<p>]</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversions_schedule","full_name":"buyer_conversions_schedule","description":"\n<p>Day is an integer representing the day of the week, 0..6, with Sunday == 0. [</p>\n\n<pre class=\"ruby\">{\n  <span class=\"ruby-value\">buyer_conversions_attributes:</span> [\n    {\n      <span class=\"ruby-value\">name:</span> <span class=\"ruby-string\">&#39;10$ conversion at 1 minute, deduped every 2 hours&#39;</span>,\n      <span class=\"ruby-value\">duration:</span> <span class=\"ruby-value\">60</span>,\n      <span class=\"ruby-value\">revenue:</span> <span class=\"ruby-value\">10</span>,\n      <span class=\"ruby-value\">duplicate_timeframe:</span> <span class=\"ruby-value\">7200</span>\n    }\n  ],\n  <span class=\"ruby-value\">schedule:</span> [{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">0</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">1</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">2</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">3</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">4</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">5</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">6</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]}]\n}\n</pre>\n\n<p>]</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_revenue_max","full_name":"current_conversion_revenue_max","description":"\n<p>The maximum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_revenue_min","full_name":"current_conversion_revenue_min","description":"\n<p>The minimum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_revenue_increment","full_name":"current_conversion_revenue_increment","description":"\n<p>Bids must be increased/decreased by this amount for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_revenue","full_name":"current_conversion_revenue","description":"\n<p>The number of dollars paid per call in increments of $0.01 for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_duration","full_name":"current_conversion_duration","description":"\n<p>The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_duplicate_timeframe","full_name":"current_conversion_duplicate_timeframe","description":"\n<p>The period of time that must elapse before a buyer will pay for the same caller to be transferred.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_name","full_name":"current_conversion_name","description":"\n<p>This name that will appear in call logs.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_token_values","full_name":"current_conversion_token_values","description":"\n<p>Conversion will only occur if the caller matches these filters.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_attribution_token_values","full_name":"current_conversion_attribution_token_values","description":"\n<p>If the call converts, these tokens will be applied to the call.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"tier\":\"-10\",\"name\":\"new name\"}' https://[your-subdomain].trackdrive.com/api/v1/buyers/:id"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/new","name":"new","apis":[{"api_url":"/api/v1/buyers/new","http_method":"GET","short_description":"Build buyer with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>buyer</th><td>Default response format.</td></tr><tr><th>buyer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/create","name":"create","apis":[{"api_url":"/api/v1/buyers","http_method":"POST","short_description":"Create a buyer.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>buyer</th><td>Default response format.</td></tr><tr><th>buyer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"copy_another_buyer","full_name":"copy_another_buyer","description":"\n<p>Copy another buyer?</p>\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":[]},{"name":"user_buyer_id","full_name":"user_buyer_id","description":"\n<p>Your external ID for this buyer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number","full_name":"number","description":"\n<p>The DID or SIP endpoint to call. DID must be prefixed with +{country code}.  Example: to dial a number in the USA, enter +1 followed by the 10 digit DID number, in UK it would be +44 followed by the DID number.  To transfer a call via SIP, begin the number with &#39;sip:&#39;.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>The name for this buyer that will appear on menus and in logs.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timeout_seconds","full_name":"timeout_seconds","description":"\n<p>Determines the time in seconds the call should ring. Must be at least 12 seconds. If the call is not answered within the ring timeout value or the default value of 120 s, it is canceled.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dtmf_tones","full_name":"dtmf_tones","description":"\n<p>Play DTMF tones when the call is answered. This is useful when dialing a phone number and an extension. Your provider will dial the number, and when the automated system picks up, sends the DTMF tones to connect to the extension. E.g. If you want to dial the 2410 extension after the call is connected, and you want to wait for a few seconds before sending the extension, add a few leading &#39;w&#39; characters. Each &#39;w&#39; character waits 0.5 second before sending a digit. Each &#39;W&#39; character waits 1 second before sending a digit.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"name":"buyer_suppression_ids","full_name":"buyer_suppression_ids","description":"\n<p>The list of internal suppression id&#39;s that will be assigned to this buyer.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Suppression}[/api/docs/1.0/buyer_suppressions/index.html]. Refer to: {/api/docs/1.0/buyer_suppressions}[/api/docs/1.0/buyer_suppressions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Pause or unpause the buyer.</p>\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":[]},{"name":"record_calls","full_name":"record_calls","description":"\n<p>Enable or Disable call recordings for this Buyer.</p>\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":[]},{"name":"press_one_to_accept","full_name":"press_one_to_accept","description":"\n<p>After answering the call the Buyer must Press 1 before being connected to the Caller.<br> Trackdrive will use the “Press 1 To Accept” call routing from the current Offer.</p>\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":[]},{"name":"generate_team","full_name":"generate_team","description":"\n<p>Grant access to edit this Buyer, and view calls that it paid for.</p>\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":[]},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n<p>The selected users will recieve an email invitation to collaborate on your company.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: <code>[\"john-smith@gmail.com\", \"example@domain.com\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n<p>Team members can view calls made to these Offers that were paid for by their Buyer.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"route_by_type","full_name":"route_by_type","description":"\n<p>Configure how calls will be routed to this Buyer. When routing by revenue the tier will be automatically calculated by taking the revenue for the current timeframe * -1.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>tier</code>, <code>revenue</code>, <code>epc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tier","full_name":"tier","description":"\n<p>When routing by revenue the tier will not be used. Buyers with the lowest tier are considered first for calls (a tier may be negative if needed).  For buyers with the same tier, the weight will then be used to calculate the % of calls the buyer gets within that tier.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"epc_timeframe","full_name":"epc_timeframe","description":"\n<p>The number of hours used when calculating the <code>EPC</code>. If there are less than <code>Minimum Required Calls</code> in this timeframe the <code>Assumed EPC</code> will be used instead.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"epc_assumed_amount","full_name":"epc_assumed_amount","description":"\n<p>The <code>Assumed EPC</code> will be used until the Buyer has received <code>Minimum Required Calls</code> calls during the <code>EPC Timeframe</code>.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"epc_assumed_calls_count","full_name":"epc_assumed_calls_count","description":"\n<p>The number of calls required during <code>EPC Timeframe</code> before the real <code>EPC</code> is used insead of the <code>Assumed EPC</code>.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"weight","full_name":"weight","description":"\n<p>The Weight of this buyer will be divided by the Total Weight of all buyers at this same Tier to get the % of calls this buyer will get within this Tier.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"display_caller_id_type","full_name":"display_caller_id_type","description":"\n<p>Select which Caller ID will be sent to this Buyer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>display_caller_id</code>, <code>display_fake_caller_id</code>, <code>display_trackdrive_number_id</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"display_trackdrive_number_id","full_name":"display_trackdrive_number_id","description":"\n<p>The Trackdrive number to display when display_caller_id_type=display_trackdrive_number_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number}[/api/docs/1.0/phone_numbers/index.html]. Refer to: {/api/docs/1.0/phone_numbers}[/api/docs/1.0/phone_numbers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"concurrency_cap_limit","full_name":"concurrency_cap_limit","description":"\n<p>Choose the number of concurrent calls that can be forwarded to this buyer simultaneously.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_total_limit","full_name":"attempt_total_limit","description":"\n<p>Attempt caps limit the number of times a buyer can be attempted in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_monthly_limit","full_name":"attempt_monthly_limit","description":"\n<p>Monthly Attempt Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attempt_daily_limit","full_name":"attempt_daily_limit","description":"\n<p>Daily Attempt Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_total_limit","full_name":"connection_total_limit","description":"\n<p>Connection caps limit the number of times a buyer can be connected in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_monthly_limit","full_name":"connection_monthly_limit","description":"\n<p>Monthly Connection Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connection_daily_limit","full_name":"connection_daily_limit","description":"\n<p>Daily Connection Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_total_limit","full_name":"buyer_conversion_total_limit","description":"\n<p>Conversion caps limit the number of times a buyer can convert in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_monthly_limit","full_name":"buyer_conversion_monthly_limit","description":"\n<p>Monthly Conversion Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_daily_limit","full_name":"buyer_conversion_daily_limit","description":"\n<p>Daily Conversion Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_total_limit","full_name":"revenue_total_limit","description":"\n<p>Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_monthly_limit","full_name":"revenue_monthly_limit","description":"\n<p>Monthly $ Revenue Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_daily_limit","full_name":"revenue_daily_limit","description":"\n<p>Daily $ Revenue Cap</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_hours_schedule","full_name":"business_hours_schedule","description":"\n<p>Day is an integer representing the day of the week, 0..6, with Sunday == 0. [</p>\n\n<pre class=\"ruby\">{\n  <span class=\"ruby-value\">attempt_hourly_limit:</span> <span class=\"ruby-value\">10</span>,\n  <span class=\"ruby-value\">connection_hourly_limit:</span> <span class=\"ruby-value\">10</span>,\n  <span class=\"ruby-value\">buyer_conversion_hourly_limit:</span> <span class=\"ruby-value\">10</span>,\n  <span class=\"ruby-value\">revenue_hourly_limit:</span> <span class=\"ruby-value\">10</span>,\n  <span class=\"ruby-value\">schedule:</span> [\n    {\n      <span class=\"ruby-value\">day:</span> <span class=\"ruby-value\">0</span>,\n      <span class=\"ruby-value\">times:</span> [<span class=\"ruby-string\">&quot;11:00..13:09&quot;</span>, <span class=\"ruby-string\">&quot;14:00..15:09&quot;</span>]\n    },\n    {\n      <span class=\"ruby-value\">day:</span> <span class=\"ruby-value\">1</span>,\n      <span class=\"ruby-value\">times:</span> [<span class=\"ruby-string\">&quot;11:10..18:39&quot;</span>, <span class=\"ruby-string\">&quot;19:10..23:39&quot;</span>]\n    }\n  ]\n}\n</pre>\n\n<p>]</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversions_schedule","full_name":"buyer_conversions_schedule","description":"\n<p>Day is an integer representing the day of the week, 0..6, with Sunday == 0. [</p>\n\n<pre class=\"ruby\">{\n  <span class=\"ruby-value\">buyer_conversions_attributes:</span> [\n    {\n      <span class=\"ruby-value\">name:</span> <span class=\"ruby-string\">&#39;10$ conversion at 1 minute, deduped every 2 hours&#39;</span>,\n      <span class=\"ruby-value\">duration:</span> <span class=\"ruby-value\">60</span>,\n      <span class=\"ruby-value\">revenue:</span> <span class=\"ruby-value\">10</span>,\n      <span class=\"ruby-value\">duplicate_timeframe:</span> <span class=\"ruby-value\">7200</span>\n    }\n  ],\n  <span class=\"ruby-value\">schedule:</span> [{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">0</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">1</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">2</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">3</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">4</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">5</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]},{<span class=\"ruby-value\">&quot;day&quot;:</span><span class=\"ruby-value\">6</span>,<span class=\"ruby-value\">&quot;times&quot;:</span>[<span class=\"ruby-string\">&quot;00:00..23:59&quot;</span>]}]\n}\n</pre>\n\n<p>]</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_revenue_max","full_name":"current_conversion_revenue_max","description":"\n<p>The maximum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_revenue_min","full_name":"current_conversion_revenue_min","description":"\n<p>The minimum valid revenue for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_revenue_increment","full_name":"current_conversion_revenue_increment","description":"\n<p>Bids must be increased/decreased by this amount for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_revenue","full_name":"current_conversion_revenue","description":"\n<p>The number of dollars paid per call in increments of $0.01 for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_duration","full_name":"current_conversion_duration","description":"\n<p>The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_duplicate_timeframe","full_name":"current_conversion_duplicate_timeframe","description":"\n<p>The period of time that must elapse before a buyer will pay for the same caller to be transferred.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_name","full_name":"current_conversion_name","description":"\n<p>This name that will appear in call logs.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_token_values","full_name":"current_conversion_token_values","description":"\n<p>Conversion will only occur if the caller matches these filters.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"current_conversion_attribution_token_values","full_name":"current_conversion_attribution_token_values","description":"\n<p>If the call converts, these tokens will be applied to the call.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"name\":\"Call Centre 1\", \"number\": \"+18004457682\"}' https://[your-subdomain].trackdrive.com/api/v1/buyers"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyers/:id","http_method":"DELETE","short_description":"Destroy an individual buyer.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>buyer</th><td>Default response format.</td></tr><tr><th>buyer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/buyers/:id\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_centers":{"doc_url":"/api/docs/1.0/call_centers","id":"call_centers","api_url":"/api","name":"Agents: Call Centers","short_description":"API resource for managing Call Centers.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_centers/index","name":"index","apis":[{"api_url":"/api/v1/call_centers","http_method":"GET","short_description":"List Call Center records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nuser_call_center_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_centers/new","name":"new","apis":[{"api_url":"/api/v1/call_centers/new","http_method":"GET","short_description":"Build Call Center with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_call_center_id","full_name":"user_call_center_id","description":"\n<p>Your external ID for this call center.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_centers/create","name":"create","apis":[{"api_url":"/api/v1/call_centers","http_method":"POST","short_description":"Create Call Center.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_call_center_id","full_name":"user_call_center_id","description":"\n<p>Your external ID for this call center.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_centers/show","name":"show","apis":[{"api_url":"/api/v1/call_centers/:id","http_method":"GET","short_description":"Get Call Center 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_centers/update","name":"update","apis":[{"api_url":"/api/v1/call_centers/:id","http_method":"PUT","short_description":"Update Call Center by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_call_center_id","full_name":"user_call_center_id","description":"\n<p>Your external ID for this call center.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_centers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_centers/:id","http_method":"DELETE","short_description":"Destroy Call Center by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_control_actions":{"doc_url":"/api/docs/1.0/call_control_actions","id":"call_control_actions","api_url":"/api","name":"Agents: Call Actions","short_description":"API resource for managing Call Action.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_control_actions/index","name":"index","apis":[{"api_url":"/api/v1/call_control_actions","http_method":"GET","short_description":"List Call Action records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nsystem_status\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ntext_color\n</li>\n<li class='column-attempt'>\nbackground_color\n</li>\n<li class='column-attempt'>\nfont_size\n</li>\n<li class='column-attempt'>\ntext_shadow_color\n</li>\n<li class='column-attempt'>\nrequire_live_caller\n</li>\n<li class='column-attempt'>\nfilter_group_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ncss_styles\n</li>\n<li class='column-attempt'>\nwebhook_actions_count\n</li>\n<li class='column-attempt'>\nopen_link_on_click\n</li>\n<li class='column-attempt'>\nopen_link_on_click_href\n</li>\n<li class='column-attempt'>\nwebhook_params_count\n</li>\n<li class='column-attempt'>\nwhisper_sound_playlist_enabled\n</li>\n<li class='column-attempt'>\nwhisper_sound_playlist_id\n</li>\n<li class='column-attempt'>\nwhisper_sound_playlist_target\n</li>\n<li class='column-attempt'>\nmessage_type\n</li>\n<li class='column-attempt'>\ntext_to_speech\n</li>\n<li class='column-attempt'>\nstop_whisper_sound_playlist\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/new","name":"new","apis":[{"api_url":"/api/v1/call_control_actions/new","http_method":"GET","short_description":"Build Call Action with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_status","full_name":"system_status","description":"\n<p>System Status</p>\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":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\n<p>Text Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\n<p>Background Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"font_size","full_name":"font_size","description":"\n<p>Font Size</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n<p>Text Shadow Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Filter Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/create","name":"create","apis":[{"api_url":"/api/v1/call_control_actions","http_method":"POST","short_description":"Create Call Action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_status","full_name":"system_status","description":"\n<p>System Status</p>\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":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\n<p>Text Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\n<p>Background Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"font_size","full_name":"font_size","description":"\n<p>Font Size</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n<p>Text Shadow Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Filter Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/show","name":"show","apis":[{"api_url":"/api/v1/call_control_actions/:id","http_method":"GET","short_description":"Get Call Action 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_control_actions/update","name":"update","apis":[{"api_url":"/api/v1/call_control_actions/:id","http_method":"PUT","short_description":"Update Call Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_status","full_name":"system_status","description":"\n<p>System Status</p>\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":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\n<p>Text Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\n<p>Background Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"font_size","full_name":"font_size","description":"\n<p>Font Size</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n<p>Text Shadow Color</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Filter Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_control_actions/:id","http_method":"DELETE","short_description":"Destroy Call Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_dispositions":{"doc_url":"/api/docs/1.0/call_dispositions","id":"call_dispositions","api_url":"/api","name":"Agents: Call Dispositions","short_description":"API resource for managing the disposition of calls.","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 records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nhint\n</li>\n<li class='column-attempt'>\nshow_on_agent_widget\n</li>\n<li class='column-attempt'>\nshow_in_tables\n</li>\n<li class='column-attempt'>\nshow_in_reports\n</li>\n<li class='column-attempt'>\napply_call_answered\n</li>\n<li class='column-attempt'>\napply_agent_handled\n</li>\n<li class='column-attempt'>\napply_buyer_handled\n</li>\n<li class='column-attempt'>\napply_qualified\n</li>\n<li class='column-attempt'>\nschedule_callback_now\n</li>\n<li class='column-attempt'>\napply_end_of_schedule\n</li>\n<li class='column-attempt'>\napply_block_caller\n</li>\n<li class='column-attempt'>\napply_auto_next_lead\n</li>\n<li class='column-attempt'>\nnotes_required\n</li>\n<li class='column-attempt'>\nfont_size\n</li>\n<li class='column-attempt'>\ntext_shadow_color\n</li>\n<li class='column-attempt'>\ntext_color\n</li>\n<li class='column-attempt'>\nbackground_color\n</li>\n<li class='column-attempt'>\nline_height\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncall_action_leave_voicemail\n</li>\n<li class='column-attempt'>\ncall_action_apply_opt_out\n</li>\n<li class='column-attempt'>\nsystem_status\n</li>\n<li class='column-attempt'>\nuse_when_blank\n</li>\n<li class='column-attempt'>\napply_machine_detected\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\ncall_disposition_action_ids\n</li>\n<li class='column-attempt'>\nreuse_conference\n</li>\n<li class='column-attempt'>\napply_add_to_schedule_suppression\n</li>\n<li class='column-attempt'>\ndelete_scheduled_callbacks\n</li>\n<li class='column-attempt'>\nscheduled_callback_chance\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"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 record with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n<p>The internal token name where values are stored.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>The friendly human name displayed to users.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Display a helpful hint to users explaining the purpose of this disposition.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n<p>Show this disposition on the agent widget?</p>\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":[]},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n<p>Show this disposition as a column on tables?</p>\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":[]},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n<p>Show this disposition as a column on reports?</p>\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":[]},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n<p>Mark the call as having been answered?</p>\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":[]},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n<p>Mark the call as having been handled by an agent?</p>\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":[]},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n<p>Mark the call as having been handled by a buyer?</p>\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":[]},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n<p>Mark the call as having been qualified?</p>\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":[]},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n<p>Trigger the end of schedule when selecting this disposition?</p>\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":[]},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n<p>Block the caller when selecting this disposition?</p>\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":[]},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n<p>Automatically move to the next lead after selecting this disposition?</p>\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":[]},{"name":"notes_required","full_name":"notes_required","description":"\n<p>Require the agent to write notes about this call?</p>\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":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"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 record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n<p>The internal token name where values are stored.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>The friendly human name displayed to users.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Display a helpful hint to users explaining the purpose of this disposition.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n<p>Show this disposition on the agent widget?</p>\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":[]},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n<p>Show this disposition as a column on tables?</p>\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":[]},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n<p>Show this disposition as a column on reports?</p>\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":[]},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n<p>Mark the call as having been answered?</p>\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":[]},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n<p>Mark the call as having been handled by an agent?</p>\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":[]},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n<p>Mark the call as having been handled by a buyer?</p>\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":[]},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n<p>Mark the call as having been qualified?</p>\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":[]},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n<p>Trigger the end of schedule when selecting this disposition?</p>\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":[]},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n<p>Block the caller when selecting this disposition?</p>\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":[]},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n<p>Automatically move to the next lead after selecting this disposition?</p>\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":[]},{"name":"notes_required","full_name":"notes_required","description":"\n<p>Require the agent to write notes about this call?</p>\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":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"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 record 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 record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n<p>The internal token name where values are stored.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>The friendly human name displayed to users.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Display a helpful hint to users explaining the purpose of this disposition.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n<p>Show this disposition on the agent widget?</p>\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":[]},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n<p>Show this disposition as a column on tables?</p>\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":[]},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n<p>Show this disposition as a column on reports?</p>\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":[]},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n<p>Mark the call as having been answered?</p>\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":[]},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n<p>Mark the call as having been handled by an agent?</p>\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":[]},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n<p>Mark the call as having been handled by a buyer?</p>\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":[]},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n<p>Mark the call as having been qualified?</p>\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":[]},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n<p>Trigger the end of schedule when selecting this disposition?</p>\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":[]},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n<p>Block the caller when selecting this disposition?</p>\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":[]},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n<p>Automatically move to the next lead after selecting this disposition?</p>\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":[]},{"name":"notes_required","full_name":"notes_required","description":"\n<p>Require the agent to write notes about this call?</p>\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":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"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 record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_logs":{"doc_url":"/api/docs/1.0/call_logs","id":"call_logs","api_url":"/api","name":"Calls: Logs","short_description":"Get the logs for a call.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_logs/index","name":"index","apis":[{"api_url":"/api/v1/call_logs","http_method":"GET","short_description":"Get the logs for a call.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_id","full_name":"call_id","description":"\n<p>The internal id for a call on Trackdrive.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_modifications":{"doc_url":"/api/docs/1.0/call_modifications","id":"call_modifications","api_url":"/api","name":"Call Modification","short_description":"API resource for managing Call Modification.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_modifications/index","name":"index","apis":[{"api_url":"/api/v1/call_modifications","http_method":"GET","short_description":"List Call Modification records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\noutgoing_webhook_ids\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nheaders\n</li>\n<li class='column-attempt'>\nerror_message\n</li>\n<li class='column-attempt'>\nimport_file_url\n</li>\n<li class='column-attempt'>\nimport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nstopped_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\ndata_source\n</li>\n<li class='column-attempt'>\ncreated_at_from\n</li>\n<li class='column-attempt'>\ncreated_at_to\n</li>\n<li class='column-attempt'>\nfilter_group_id\n</li>\n<li class='column-attempt'>\ncall_modification_logs\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_modifications/new","name":"new","apis":[{"api_url":"/api/v1/call_modifications/new","http_method":"GET","short_description":"Build Call Modification with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Paused</p>\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":[]},{"name":"outgoing_webhook_ids","full_name":"outgoing_webhook_ids","description":"\n<p>Outgoing Webhook Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Status</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_modifications/create","name":"create","apis":[{"api_url":"/api/v1/call_modifications","http_method":"POST","short_description":"Create Call Modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Paused</p>\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":[]},{"name":"outgoing_webhook_ids","full_name":"outgoing_webhook_ids","description":"\n<p>Outgoing Webhook Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Status</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_modifications/show","name":"show","apis":[{"api_url":"/api/v1/call_modifications/:id","http_method":"GET","short_description":"Get Call Modification 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_modifications/update","name":"update","apis":[{"api_url":"/api/v1/call_modifications/:id","http_method":"PUT","short_description":"Update Call Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Paused</p>\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":[]},{"name":"outgoing_webhook_ids","full_name":"outgoing_webhook_ids","description":"\n<p>Outgoing Webhook Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Status</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_modifications/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_modifications/:id","http_method":"DELETE","short_description":"Destroy Call Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_recording_rules":{"doc_url":"/api/docs/1.0/call_recording_rules","id":"call_recording_rules","api_url":"/api","name":"Calls: Recording Retention","short_description":"API resource for managing Call Recording Retention.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_recording_rules/index","name":"index","apis":[{"api_url":"/api/v1/call_recording_rules","http_method":"GET","short_description":"List Call Recording Retention records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nrecording_type\n</li>\n<li class='column-attempt'>\nretention_seconds\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\ncompleted_at\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_recording_rules/new","name":"new","apis":[{"api_url":"/api/v1/call_recording_rules/new","http_method":"GET","short_description":"Build Call Recording Retention with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recording_type","full_name":"recording_type","description":"\n<p>This type of recording will be deleted once the retention period has passed.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>call</code>, <code>consumer_and_agent</code>, <code>consumer_and_buyer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"retention_seconds","full_name":"retention_seconds","description":"\n<p>If a recording is older than this many seconds, it will be deleted.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Only recordings matching this offer will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Only recordings matching this Schedule will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Only recordings matching this Buyer will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Only recordings matching this Traffic Source will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_recording_rules/create","name":"create","apis":[{"api_url":"/api/v1/call_recording_rules","http_method":"POST","short_description":"Create Call Recording Retention.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recording_type","full_name":"recording_type","description":"\n<p>This type of recording will be deleted once the retention period has passed.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>call</code>, <code>consumer_and_agent</code>, <code>consumer_and_buyer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"retention_seconds","full_name":"retention_seconds","description":"\n<p>If a recording is older than this many seconds, it will be deleted.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Only recordings matching this offer will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Only recordings matching this Schedule will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Only recordings matching this Buyer will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Only recordings matching this Traffic Source will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_recording_rules/show","name":"show","apis":[{"api_url":"/api/v1/call_recording_rules/:id","http_method":"GET","short_description":"Get Call Recording Retention 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_recording_rules/update","name":"update","apis":[{"api_url":"/api/v1/call_recording_rules/:id","http_method":"PUT","short_description":"Update Call Recording Retention by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recording_type","full_name":"recording_type","description":"\n<p>This type of recording will be deleted once the retention period has passed.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>call</code>, <code>consumer_and_agent</code>, <code>consumer_and_buyer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"retention_seconds","full_name":"retention_seconds","description":"\n<p>If a recording is older than this many seconds, it will be deleted.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Only recordings matching this offer will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Only recordings matching this Schedule will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Only recordings matching this Buyer will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Only recordings matching this Traffic Source will be deleted after the retention period.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_recording_rules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_recording_rules/:id","http_method":"DELETE","short_description":"Destroy Call Recording Retention by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_router_answer_groups":{"doc_url":"/api/docs/1.0/call_router_answer_groups","id":"call_router_answer_groups","api_url":"/api","name":"Offers: Call Flow: Answer Groups","short_description":"API resource for managing Call Flow Answer Groups.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_router_answer_groups/index","name":"index","apis":[{"api_url":"/api/v1/call_router_answer_groups","http_method":"GET","short_description":"List Answer Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ncall_router_answers_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answer_groups/new","name":"new","apis":[{"api_url":"/api/v1/call_router_answer_groups/new","http_method":"GET","short_description":"Build Answer Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\n<p>Translation missing: en.api.call_router_answer_groups.call_router_answers_count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answer_groups/create","name":"create","apis":[{"api_url":"/api/v1/call_router_answer_groups","http_method":"POST","short_description":"Create Answer Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\n<p>Translation missing: en.api.call_router_answer_groups.call_router_answers_count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answer_groups/show","name":"show","apis":[{"api_url":"/api/v1/call_router_answer_groups/:id","http_method":"GET","short_description":"Get Answer Group 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_router_answer_groups/update","name":"update","apis":[{"api_url":"/api/v1/call_router_answer_groups/:id","http_method":"PUT","short_description":"Update Answer Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\n<p>Translation missing: en.api.call_router_answer_groups.call_router_answers_count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answer_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_router_answer_groups/:id","http_method":"DELETE","short_description":"Destroy Answer Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_router_answers":{"doc_url":"/api/docs/1.0/call_router_answers","id":"call_router_answers","api_url":"/api","name":"Offers: Call Flow: Answers","short_description":"API resource for managing Call Flow Answers.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_router_answers/index","name":"index","apis":[{"api_url":"/api/v1/call_router_answers","http_method":"GET","short_description":"List Answer records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\ncall_router_answer_group_id\n</li>\n<li class='column-attempt'>\nkey_press\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\noutgoing_webhook_ids\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answers/new","name":"new","apis":[{"api_url":"/api/v1/call_router_answers/new","http_method":"GET","short_description":"Build Answer with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_router_answer_group_id","full_name":"call_router_answer_group_id","description":"\n<p>Answer Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_press","full_name":"key_press","description":"\n<p>Key Press</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Filters</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.call_router_answers.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Additional Tokens</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Translation missing: en.api.call_router_answers.attribution_token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answers/create","name":"create","apis":[{"api_url":"/api/v1/call_router_answers","http_method":"POST","short_description":"Create Answer.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_router_answer_group_id","full_name":"call_router_answer_group_id","description":"\n<p>Answer Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_press","full_name":"key_press","description":"\n<p>Key Press</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Filters</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.call_router_answers.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Additional Tokens</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Translation missing: en.api.call_router_answers.attribution_token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answers/show","name":"show","apis":[{"api_url":"/api/v1/call_router_answers/:id","http_method":"GET","short_description":"Get Answer 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_router_answers/update","name":"update","apis":[{"api_url":"/api/v1/call_router_answers/:id","http_method":"PUT","short_description":"Update Answer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_router_answer_group_id","full_name":"call_router_answer_group_id","description":"\n<p>Answer Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_press","full_name":"key_press","description":"\n<p>Key Press</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Filters</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.call_router_answers.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Additional Tokens</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Translation missing: en.api.call_router_answers.attribution_token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_router_answers/:id","http_method":"DELETE","short_description":"Destroy Answer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_routers":{"doc_url":"/api/docs/1.0/call_routers","id":"call_routers","api_url":"/api","name":"Offers: Call Flow","short_description":"API resource for managing Call Flow. This resource is used to manage rules for Call Handling, Exception Handling, and Hold Queue Handling.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_routers/index","name":"index","apis":[{"api_url":"/api/v1/call_routers","http_method":"GET","short_description":"List Call Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncategory\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nmessage_type\n</li>\n<li class='column-attempt'>\nmessage_action\n</li>\n<li class='column-attempt'>\nmessage_loop\n</li>\n<li class='column-attempt'>\ntext_to_speech\n</li>\n<li class='column-attempt'>\ntext_to_speech_gender\n</li>\n<li class='column-attempt'>\nrouter_action\n</li>\n<li class='column-attempt'>\naction_option\n</li>\n<li class='column-attempt'>\nbuyer_ids\n</li>\n<li class='column-attempt'>\nbuyer_offer_ids\n</li>\n<li class='column-attempt'>\nbuyer_group_ids\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\noutbound_timeout_seconds\n</li>\n<li class='column-attempt'>\nrouter_type\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nmessage_action_type\n</li>\n<li class='column-attempt'>\nkey_press_timeout_seconds\n</li>\n<li class='column-attempt'>\nperform_action_if_buyer_is_available\n</li>\n<li class='column-attempt'>\ninbound_call_route_async\n</li>\n<li class='column-attempt'>\nbackup_buyer_ids\n</li>\n<li class='column-attempt'>\nbackup_buyer_group_ids\n</li>\n<li class='column-attempt'>\nuse_sound_playlist\n</li>\n<li class='column-attempt'>\nsound_playlist_id\n</li>\n<li class='column-attempt'>\nhold_music_sound_playlist_id\n</li>\n<li class='column-attempt'>\nvoicemail_sound_playlist_id\n</li>\n<li class='column-attempt'>\nhas_schedule\n</li>\n<li class='column-attempt'>\nhas_extension_pool\n</li>\n<li class='column-attempt'>\nallows_outgoing_webhooks\n</li>\n<li class='column-attempt'>\nuse_with_find_a_buyer\n</li>\n<li class='column-attempt'>\nuse_with_key_press_flows\n</li>\n<li class='column-attempt'>\nkey_press_flow_group_id\n</li>\n<li class='column-attempt'>\nauto_retry_next_buyer\n</li>\n<li class='column-attempt'>\nauto_retry_next_buyer_seconds\n</li>\n<li class='column-attempt'>\nhas_extension_actions\n</li>\n<li class='column-attempt'>\nhas_schedule_action\n</li>\n<li class='column-attempt'>\ncan_dial\n</li>\n<li class='column-attempt'>\ncan_alter_traffic_source\n</li>\n<li class='column-attempt'>\nmax_call_disposition_wait_seconds\n</li>\n<li class='column-attempt'>\nhold_queue_caller_limit\n</li>\n<li class='column-attempt'>\nhold_queue_percentage_size\n</li>\n<li class='column-attempt'>\nmax_hold_seconds\n</li>\n<li class='column-attempt'>\nmax_hold_seconds_average\n</li>\n<li class='column-attempt'>\nfire_call_router_webhooks_before_action\n</li>\n<li class='column-attempt'>\naction_digit\n</li>\n<li class='column-attempt'>\noff_hook_calls_per_seat\n</li>\n<li class='column-attempt'>\noff_hook_unaccepted_wait\n</li>\n<li class='column-attempt'>\noff_hook_leads_needed\n</li>\n<li class='column-attempt'>\naudio_file_url\n</li>\n<li class='column-attempt'>\nvoicemail_file_url\n</li>\n<li class='column-attempt'>\nhold_music_file_url\n</li>\n<li class='column-attempt'>\ncall_router_hangup_reason\n</li>\n<li class='column-attempt'>\ncall_router_answer_group_id\n</li>\n<li class='column-attempt'>\noff_hook_no_lead_timeout\n</li>\n<li class='column-attempt'>\noutgoing_webhook_ids\n</li>\n<li class='column-attempt'>\nafter_action_sound_playlist_enabled\n</li>\n<li class='column-attempt'>\nafter_action_sound_playlist_id\n</li>\n<li class='column-attempt'>\noff_hook_dropped_call_seconds\n</li>\n<li class='column-attempt'>\noff_hook_drop_limit_1\n</li>\n<li class='column-attempt'>\noff_hook_drop_cps_1\n</li>\n<li class='column-attempt'>\noff_hook_drop_limit_2\n</li>\n<li class='column-attempt'>\noff_hook_drop_cps_2\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n<li class='column-attempt'>\noff_hook_dropped_calls\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_routers/new","name":"new","apis":[{"api_url":"/api/v1/call_routers/new","http_method":"GET","short_description":"Build Call Flow Rule with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"message_type","full_name":"message_type","description":"\n<p>Play A Message?</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>none</th><td>No Message</td></tr><tr><th>speak</th><td>Speak TTS</td></tr><tr><th>audio</th><td>Play Audio</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"router_action","full_name":"router_action","description":"\n<p>Choose An Action</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>dial</th><td>Forward To Buyers</td></tr><tr><th>redirect</th><td>Forward To Offer</td></tr><tr><th>add_to_schedule</th><td>Add To Schedule</td></tr><tr><th>add_to_hold_queue</th><td>Place Caller In Hold Queue</td></tr><tr><th>remove_from_schedule</th><td>Remove From Schedule</td></tr><tr><th>record_voicemail</th><td>Record Voicemail</td></tr><tr><th>request_key_press</th><td>Request Key Press</td></tr><tr><th>block_caller</th><td>Block Caller</td></tr><tr><th>end_call</th><td>Hang Up</td></tr><tr><th>none</th><td>Continue Offer Routing</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Describe the purpose of this call flow rule.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n<p>Text To Speech that will be spoken when <code>message_type=speak</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_loop","full_name":"message_loop","description":"\n<p>The message will be repeated this many times.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"audio_file","full_name":"audio_file","description":"\n<p>The audio file that will be played when <code>message_type=audio</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>The schedule that will be used when <code>router_action=add_to_schedule</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>Calls will be forwarded to these buyers when <code>router_action=dial</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Calls will be forwarded to these buyer groups when <code>router_action=dial</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Group}[/api/docs/1.0/buyer_groups/index.html]. Refer to: {/api/docs/1.0/buyer_groups}[/api/docs/1.0/buyer_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n<p>Calls will be forwarded to this offer when <code>router_action=redirect</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. How many people can be on hold?</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Set the hold queue size automatically by taking [Active CC * This Percentage]</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Maximum number of seconds a caller can be on hold.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_routers/create","name":"create","apis":[{"api_url":"/api/v1/call_routers","http_method":"POST","short_description":"Create Call Flow Rule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"router_type","full_name":"router_type","description":"\n<p>The type of Call Flow Rule.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>ask_a_question</th><td>Ask A Question And Request An Answer</td></tr><tr><th>no_greeting_is_played</th><td>Handle Call When No Keypress Is Requested</td></tr><tr><th>when_answering_machine_detected</th><td>When an answering machine is detected</td></tr><tr><th>greeting</th><td>Play A Greeting Message And Request A Keypress</td></tr><tr><th>off_hook_press_to_accept</th><td>When Getting Instant Agents On The Phone</td></tr><tr><th>key_press_1</th><td>When 1 is Pressed</td></tr><tr><th>key_press_2</th><td>When 2 is pressed</td></tr><tr><th>key_press_3</th><td>When 3 is pressed</td></tr><tr><th>key_press_4</th><td>When 4 is pressed</td></tr><tr><th>key_press_5</th><td>When 5 is pressed</td></tr><tr><th>key_press_6</th><td>When 6 is pressed</td></tr><tr><th>key_press_7</th><td>When 7 is pressed</td></tr><tr><th>key_press_8</th><td>When 8 is pressed</td></tr><tr><th>key_press_9</th><td>When 9 is pressed</td></tr><tr><th>key_press_#</th><td>When # is pressed</td></tr><tr><th>key_press_*</th><td>When * is pressed</td></tr><tr><th>key_press_0</th><td>When 0 is pressed</td></tr><tr><th>no_key_press</th><td>When nothing is pressed</td></tr><tr><th>any_other_key_press</th><td>When anything is pressed</td></tr><tr><th>calling_buyer_music</th><td>Calling Buyer Music Played to Caller during Transfers</td></tr><tr><th>whisper</th><td>Whisper To Buyer that a Call is being Transferred</td></tr><tr><th>enter_extension</th><td>Enter Extension</td></tr><tr><th>extension_failed</th><td>When an invalid extension is entered</td></tr><tr><th>zip_code_entry</th><td>Enter Zip Code</td></tr><tr><th>zip_entry_failed</th><td>Incorrect Zip Code</td></tr><tr><th>press_1_to_accept</th><td>Whisper to Buyer to Press 1 to Accept a Call</td></tr><tr><th>press_1_too_slow</th><td>Whisper to Buyer that they Pressed 1 Too Slowly</td></tr><tr><th>add_to_hold_queue</th><td>When placed in hold queue</td></tr><tr><th>hold_queue_is_full</th><td>When the hold queue is full</td></tr><tr><th>hold_queue_max_seconds_exceeded</th><td>When the caller has been on hold for longer than max hold seconds</td></tr><tr><th>no_instant_agent_available</th><td>When no instant agent is available during an inbound call from a consumer</td></tr><tr><th>no_instant_agent_available_outbound</th><td>When no instant agent is available during an outbound call to a consumer</td></tr><tr><th>when_instant_agent_transfers_to_buyer</th><td>When an instant agent transfers to a buyer</td></tr><tr><th>when_buyer_hangup_before_duration</th><td>When A Buyer Hangs Up Before Duration</td></tr><tr><th>no_buyers_have_open_concurrency_cap</th><td>When no buyers have open concurrency cap</td></tr><tr><th>all_buyers_closed</th><td>When no buyers are open</td></tr><tr><th>no_buyer_answered</th><td>When no buyers answer</td></tr><tr><th>no_buyers_match</th><td>When no buyers have matching filters</td></tr><tr><th>tag_validation_failed</th><td>Token Entry Failed</td></tr><tr><th>traffic_source_capped</th><td>When the traffic source is capped</td></tr><tr><th>caller_hang_up_before_conference</th><td>When the caller hangs up before being connected to a buyer</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_type","full_name":"message_type","description":"\n<p>Play A Message?</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>none</th><td>No Message</td></tr><tr><th>speak</th><td>Speak TTS</td></tr><tr><th>audio</th><td>Play Audio</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"router_action","full_name":"router_action","description":"\n<p>Choose An Action</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>dial</th><td>Forward To Buyers</td></tr><tr><th>redirect</th><td>Forward To Offer</td></tr><tr><th>add_to_schedule</th><td>Add To Schedule</td></tr><tr><th>add_to_hold_queue</th><td>Place Caller In Hold Queue</td></tr><tr><th>remove_from_schedule</th><td>Remove From Schedule</td></tr><tr><th>record_voicemail</th><td>Record Voicemail</td></tr><tr><th>request_key_press</th><td>Request Key Press</td></tr><tr><th>block_caller</th><td>Block Caller</td></tr><tr><th>end_call</th><td>Hang Up</td></tr><tr><th>none</th><td>Continue Offer Routing</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Describe the purpose of this call flow rule.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n<p>Text To Speech that will be spoken when <code>message_type=speak</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_loop","full_name":"message_loop","description":"\n<p>The message will be repeated this many times.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"audio_file","full_name":"audio_file","description":"\n<p>The audio file that will be played when <code>message_type=audio</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>The schedule that will be used when <code>router_action=add_to_schedule</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>Calls will be forwarded to these buyers when <code>router_action=dial</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Calls will be forwarded to these buyer groups when <code>router_action=dial</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Group}[/api/docs/1.0/buyer_groups/index.html]. Refer to: {/api/docs/1.0/buyer_groups}[/api/docs/1.0/buyer_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n<p>Calls will be forwarded to this offer when <code>router_action=redirect</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. How many people can be on hold?</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Set the hold queue size automatically by taking [Active CC * This Percentage]</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Maximum number of seconds a caller can be on hold.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_routers/show","name":"show","apis":[{"api_url":"/api/v1/call_routers/:id","http_method":"GET","short_description":"Get Call Flow Rule 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_routers/update","name":"update","apis":[{"api_url":"/api/v1/call_routers/:id","http_method":"PUT","short_description":"Update Call Flow Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_type","full_name":"message_type","description":"\n<p>Play A Message?</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>none</th><td>No Message</td></tr><tr><th>speak</th><td>Speak TTS</td></tr><tr><th>audio</th><td>Play Audio</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"router_action","full_name":"router_action","description":"\n<p>Choose An Action</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>dial</th><td>Forward To Buyers</td></tr><tr><th>redirect</th><td>Forward To Offer</td></tr><tr><th>add_to_schedule</th><td>Add To Schedule</td></tr><tr><th>add_to_hold_queue</th><td>Place Caller In Hold Queue</td></tr><tr><th>remove_from_schedule</th><td>Remove From Schedule</td></tr><tr><th>record_voicemail</th><td>Record Voicemail</td></tr><tr><th>request_key_press</th><td>Request Key Press</td></tr><tr><th>block_caller</th><td>Block Caller</td></tr><tr><th>end_call</th><td>Hang Up</td></tr><tr><th>none</th><td>Continue Offer Routing</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Describe the purpose of this call flow rule.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n<p>Text To Speech that will be spoken when <code>message_type=speak</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_loop","full_name":"message_loop","description":"\n<p>The message will be repeated this many times.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"audio_file","full_name":"audio_file","description":"\n<p>The audio file that will be played when <code>message_type=audio</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>The schedule that will be used when <code>router_action=add_to_schedule</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>Calls will be forwarded to these buyers when <code>router_action=dial</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Calls will be forwarded to these buyer groups when <code>router_action=dial</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Group}[/api/docs/1.0/buyer_groups/index.html]. Refer to: {/api/docs/1.0/buyer_groups}[/api/docs/1.0/buyer_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n<p>Calls will be forwarded to this offer when <code>router_action=redirect</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. How many people can be on hold?</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Set the hold queue size automatically by taking [Active CC * This Percentage]</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Maximum number of seconds a caller can be on hold.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n<p>Used when <code>router_type=add_to_hold_queue</code>. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_routers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_routers/:id","http_method":"DELETE","short_description":"Destroy Call Flow Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"calls":{"doc_url":"/api/docs/1.0/calls","id":"calls","api_url":"/api","name":"Calls","short_description":"The phone calls that have been made to and from your account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/calls/index","name":"index","apis":[{"api_url":"/api/v1/calls","http_method":"GET","short_description":"List calls.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>call</th><td>Default response format.</td></tr><tr><th>call_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cursor","full_name":"cursor","description":"\n<p>The API provides a technique called ‘cursoring&#39; to paginate large result sets. Cursoring separates results into pages (the size of which are defined by the per_page request parameter) and provides a means to move backwards and forwards through these pages. To retrieve cursored results, you initially pass a cursor with a value of -1 to the endpoint. By default, an API endpoint that supports cursoring will assume -1 was passed as cursor if you do not provide one. The response to a cursored request will contain <strong>metadata.next_cursor</strong>. The next_cursor is the cursor that you should send to the endpoint to receive the next batch of responses. You will know that you have requested the last available page of results when the API responds with a next_cursor = 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nrecording_url\n</li>\n<li class='column-attempt'>\ncategory\n</li>\n<li class='column-attempt'>\nnumber_called\n</li>\n<li class='column-attempt'>\nnumber_id\n</li>\n<li class='column-attempt'>\nconnected_to\n</li>\n<li class='column-attempt'>\ncaller_number\n</li>\n<li class='column-attempt'>\noffer\n</li>\n<li class='column-attempt'>\nuser_offer_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nquality_assurance_user_id\n</li>\n<li class='column-attempt'>\nquality_assurance_name\n</li>\n<li class='column-attempt'>\nquality_assurance_id\n</li>\n<li class='column-attempt'>\nagent_id\n</li>\n<li class='column-attempt'>\ntraffic_source\n</li>\n<li class='column-attempt'>\nuser_traffic_source_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nbuyer\n</li>\n<li class='column-attempt'>\nuser_buyer_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\nobfuscated_caller_number\n</li>\n<li class='column-attempt'>\ncaller_city\n</li>\n<li class='column-attempt'>\ncaller_country\n</li>\n<li class='column-attempt'>\ntoken_values\n</li>\n<li class='column-attempt'>\ntotal_duration\n</li>\n<li class='column-attempt'>\nhold_duration\n</li>\n<li class='column-attempt'>\nivr_duration\n</li>\n<li class='column-attempt'>\nattempted_duration\n</li>\n<li class='column-attempt'>\nanswered_duration\n</li>\n<li class='column-attempt'>\nagent_duration\n</li>\n<li class='column-attempt'>\nsub_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nschedule_name\n</li>\n<li class='column-attempt'>\nring_pool_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nbuyer_converted\n</li>\n<li class='column-attempt'>\nbuyer_repeat_caller\n</li>\n<li class='column-attempt'>\nbuyer_revenue\n</li>\n<li class='column-attempt'>\nrevenue\n</li>\n<li class='column-attempt'>\ntraffic_source_converted\n</li>\n<li class='column-attempt'>\ntraffic_source_repeat_caller\n</li>\n<li class='column-attempt'>\ntraffic_source_payout\n</li>\n<li class='column-attempt'>\npayout\n</li>\n<li class='column-attempt'>\ntrackdrive_cost\n</li>\n<li class='column-attempt'>\nprovider_cost\n</li>\n<li class='column-attempt'>\ncall_sid\n</li>\n<li class='column-attempt'>\nprovider\n</li>\n<li class='column-attempt'>\noutgoing_webhooks_count\n</li>\n<li class='column-attempt'>\nended_at\n</li>\n<li class='column-attempt'>\ncontact_field_type\n</li>\n<li class='column-attempt'>\ndisposition_id\n</li>\n<li class='column-attempt'>\ndisposition_key\n</li>\n<li class='column-attempt'>\ndisposition_name\n</li>\n<li class='column-attempt'>\ndisposition_notes\n</li>\n<li class='column-attempt'>\nhangup_cause\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]},{"name":"created_at_label","full_name":"created_at_label","description":"\n<p>Dynamic Date String such as “Today” or “This Year”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>Last 5 Min</code>, <code>Last 15 Min</code>, <code>Last 30 Min</code>, <code>Last Hour</code>, <code>Last 4 Hours</code>, <code>Last 6 Hours</code>, <code>Last 12 Hours</code>, <code>Last Day</code>, <code>Last 2 Days</code>, <code>Today</code>, <code>Yesterday</code>, <code>This Week</code>, <code>Last Week</code>, <code>This Month</code>, <code>Last Month</code>, <code>This Quarter</code>, <code>Last Quarter</code>, <code>Last 6 Months</code>, <code>This Year</code>, <code>Last Year</code>, <code>Lifetime</code>, <code>Custom Range</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_repeat_caller","full_name":"offer_repeat_caller","description":"\n<p>Match calls where the Traffic Source had a repeat caller.</p>\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":[]},{"name":"buyer_repeat_caller","full_name":"buyer_repeat_caller","description":"\n<p>Match calls where the Buyer had a repeat caller.</p>\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":[]},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n<p>Did the buyer convert?</p>\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":[]},{"name":"offer_converted","full_name":"offer_converted","description":"\n<p>Did the traffic source convert?</p>\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":[]},{"name":"in_progress","full_name":"in_progress","description":"\n<p>Match calls that are on-going</p>\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":[]},{"name":"placed_on_hold","full_name":"placed_on_hold","description":"\n<p>Was the call placed on hold?</p>\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":[]},{"name":"has_recording","full_name":"has_recording","description":"\n<p>Match calls that have a recording.</p>\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":[]},{"name":"either_converted","full_name":"either_converted","description":"\n<p>Whether this call&#39;s buyer or traffic source has converted.</p>\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":[]},{"name":"buyer_conversion_duplicated_call","full_name":"buyer_conversion_duplicated_call","description":"\n<p>Match calls where the callerID was a duplicate against the Buyer&#39;s conversion settings.</p>\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":[]},{"name":"offer_conversion_duplicated_call","full_name":"offer_conversion_duplicated_call","description":"\n<p>Match calls where the callerID was a duplicate against the Traffic Source&#39;s conversion settings.</p>\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":[]},{"name":"no_buyer","full_name":"no_buyer","description":"\n<p>Match calls that didn&#39;t connect to a Buyer</p>\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":[]},{"name":"token_key","full_name":"token_key","description":"\n<p>Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value","full_name":"token_value","description":"\n<p>Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n<p>Sort results by this field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>direction</code>, <code>updated_at</code>, <code>start_app_duration</code>, <code>number_id</code>, <code>offer_id</code>, <code>traffic_source_id</code>, <code>sub_id</code>, <code>buyer_id</code>, <code>caller_number</code>, <code>updated_at</code>, <code>total_duration</code>, <code>hold_duration</code>, <code>ivr_duration</code>, <code>third_party_cost</code>, <code>charge_total</code>, <code>answered_duration</code>, <code>agent_duration</code>, <code>status</code>, <code>buyer_converted</code>, <code>revenue</code>, <code>offer_converted</code>, <code>payout</code>, <code>outgoing_webhooks_count</code>, <code>created_at</code>, <code>end_time</code>, <code>lead_id</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_dir","full_name":"order_dir","description":"\n<p>Sort results in ascending or descending order.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>desc</code>, <code>asc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_id","full_name":"number_id","description":"\n<p>Refer to the number api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule internal id.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Refer to the buyer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Buyer Group Internal ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Refer to the Number Pool api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>An Integer number eg: 12345</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Refer to the provider api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_id","full_name":"contact_id","description":"\n<p>Match calls that were placed by this caller.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Match results that have this status.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ended_at_to","full_name":"ended_at_to","description":"\n<p>Date formatted like 2016-01-01 12:00:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ended_at_from","full_name":"ended_at_from","description":"\n<p>Date formatted like 2016-01-01 12:00:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls?page=1&in_progress=true&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/index_by_caller_number","name":"index_by_caller_number","apis":[{"api_url":"/api/v1/calls/:caller_number/by_caller_number","http_method":"GET","short_description":"List calls by caller number.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>call</th><td>Default response format.</td></tr><tr><th>call_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_number","full_name":"caller_number","description":"\n<p>The caller number. EG: +17191112222</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/17191231234/by_caller_number\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/live_calls","name":"live_calls","apis":[{"api_url":"/api/v1/calls/live_calls","http_method":"GET","short_description":"List ongoing live calls.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>call</th><td>Default response format.</td></tr><tr><th>call_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/live_calls\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/reports","name":"reports","apis":[{"api_url":"/api/v1/calls/reports","http_method":"GET","short_description":"Get statistics on calls by category.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"category","full_name":"category","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nrecording_url\n</li>\n<li class='column-attempt'>\ncategory\n</li>\n<li class='column-attempt'>\nnumber_called\n</li>\n<li class='column-attempt'>\nnumber_id\n</li>\n<li class='column-attempt'>\nconnected_to\n</li>\n<li class='column-attempt'>\ncaller_number\n</li>\n<li class='column-attempt'>\noffer\n</li>\n<li class='column-attempt'>\nuser_offer_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nquality_assurance_user_id\n</li>\n<li class='column-attempt'>\nquality_assurance_name\n</li>\n<li class='column-attempt'>\nquality_assurance_id\n</li>\n<li class='column-attempt'>\nagent_id\n</li>\n<li class='column-attempt'>\ntraffic_source\n</li>\n<li class='column-attempt'>\nuser_traffic_source_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nbuyer\n</li>\n<li class='column-attempt'>\nuser_buyer_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\nobfuscated_caller_number\n</li>\n<li class='column-attempt'>\ncaller_city\n</li>\n<li class='column-attempt'>\ncaller_country\n</li>\n<li class='column-attempt'>\ntoken_values\n</li>\n<li class='column-attempt'>\ntotal_duration\n</li>\n<li class='column-attempt'>\nhold_duration\n</li>\n<li class='column-attempt'>\nivr_duration\n</li>\n<li class='column-attempt'>\nattempted_duration\n</li>\n<li class='column-attempt'>\nanswered_duration\n</li>\n<li class='column-attempt'>\nagent_duration\n</li>\n<li class='column-attempt'>\nsub_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nschedule_name\n</li>\n<li class='column-attempt'>\nring_pool_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nbuyer_converted\n</li>\n<li class='column-attempt'>\nbuyer_repeat_caller\n</li>\n<li class='column-attempt'>\nbuyer_revenue\n</li>\n<li class='column-attempt'>\nrevenue\n</li>\n<li class='column-attempt'>\ntraffic_source_converted\n</li>\n<li class='column-attempt'>\ntraffic_source_repeat_caller\n</li>\n<li class='column-attempt'>\ntraffic_source_payout\n</li>\n<li class='column-attempt'>\npayout\n</li>\n<li class='column-attempt'>\ntrackdrive_cost\n</li>\n<li class='column-attempt'>\nprovider_cost\n</li>\n<li class='column-attempt'>\ncall_sid\n</li>\n<li class='column-attempt'>\nprovider\n</li>\n<li class='column-attempt'>\noutgoing_webhooks_count\n</li>\n<li class='column-attempt'>\nended_at\n</li>\n<li class='column-attempt'>\ncontact_field_type\n</li>\n<li class='column-attempt'>\ndisposition_id\n</li>\n<li class='column-attempt'>\ndisposition_key\n</li>\n<li class='column-attempt'>\ndisposition_name\n</li>\n<li class='column-attempt'>\ndisposition_notes\n</li>\n<li class='column-attempt'>\nhangup_cause\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]},{"name":"offer_repeat_caller","full_name":"offer_repeat_caller","description":"\n<p>Match calls where the Traffic Source had a repeat caller.</p>\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":[]},{"name":"buyer_repeat_caller","full_name":"buyer_repeat_caller","description":"\n<p>Match calls where the Buyer had a repeat caller.</p>\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":[]},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n<p>Did the buyer convert?</p>\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":[]},{"name":"offer_converted","full_name":"offer_converted","description":"\n<p>Did the traffic source convert?</p>\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":[]},{"name":"in_progress","full_name":"in_progress","description":"\n<p>Match calls that are on-going</p>\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":[]},{"name":"placed_on_hold","full_name":"placed_on_hold","description":"\n<p>Was the call placed on hold?</p>\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":[]},{"name":"has_recording","full_name":"has_recording","description":"\n<p>Match calls that have a recording.</p>\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":[]},{"name":"either_converted","full_name":"either_converted","description":"\n<p>Whether this call&#39;s buyer or traffic source has converted.</p>\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":[]},{"name":"buyer_conversion_duplicated_call","full_name":"buyer_conversion_duplicated_call","description":"\n<p>Match calls where the callerID was a duplicate against the Buyer&#39;s conversion settings.</p>\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":[]},{"name":"offer_conversion_duplicated_call","full_name":"offer_conversion_duplicated_call","description":"\n<p>Match calls where the callerID was a duplicate against the Traffic Source&#39;s conversion settings.</p>\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":[]},{"name":"no_buyer","full_name":"no_buyer","description":"\n<p>Match calls that didn&#39;t connect to a Buyer</p>\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":[]},{"name":"token_key","full_name":"token_key","description":"\n<p>Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value","full_name":"token_value","description":"\n<p>Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n<p>Sort results by this field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>direction</code>, <code>updated_at</code>, <code>start_app_duration</code>, <code>number_id</code>, <code>offer_id</code>, <code>traffic_source_id</code>, <code>sub_id</code>, <code>buyer_id</code>, <code>caller_number</code>, <code>updated_at</code>, <code>total_duration</code>, <code>hold_duration</code>, <code>ivr_duration</code>, <code>third_party_cost</code>, <code>charge_total</code>, <code>answered_duration</code>, <code>agent_duration</code>, <code>status</code>, <code>buyer_converted</code>, <code>revenue</code>, <code>offer_converted</code>, <code>payout</code>, <code>outgoing_webhooks_count</code>, <code>created_at</code>, <code>end_time</code>, <code>lead_id</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_dir","full_name":"order_dir","description":"\n<p>Sort results in ascending or descending order.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>desc</code>, <code>asc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_id","full_name":"number_id","description":"\n<p>Refer to the number api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule internal id.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Refer to the buyer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Buyer Group Internal ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Refer to the Number Pool api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>An Integer number eg: 12345</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Refer to the provider api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_id","full_name":"contact_id","description":"\n<p>Match calls that were placed by this caller.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Match results that have this status.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ended_at_to","full_name":"ended_at_to","description":"\n<p>Date formatted like 2016-01-01 12:00:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ended_at_from","full_name":"ended_at_from","description":"\n<p>Date formatted like 2016-01-01 12:00:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/reports?category=buyer_id&\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/stats","name":"stats","apis":[{"api_url":"/api/v1/calls/stats","http_method":"GET","short_description":"Get statistics on calls by category and interval.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"group_by","full_name":"group_by","description":"\n<p>Group calls by one of these attributes.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>buyer_converted</code>, <code>offer_converted</code>, <code>status</code>, <code>created_at_five_minutes</code>, <code>created_at_day</code>, <code>created_at_week</code>, <code>created_at_month</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stat","full_name":"stat","description":"\n<p>Return statistics on the grouped calls by one of these numeric columns.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>count</code>, <code>revenue</code>, <code>profit</code>, <code>cost</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"offer_repeat_caller","full_name":"offer_repeat_caller","description":"\n<p>Match calls where the Traffic Source had a repeat caller.</p>\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":[]},{"name":"buyer_repeat_caller","full_name":"buyer_repeat_caller","description":"\n<p>Match calls where the Buyer had a repeat caller.</p>\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":[]},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n<p>Did the buyer convert?</p>\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":[]},{"name":"offer_converted","full_name":"offer_converted","description":"\n<p>Did the traffic source convert?</p>\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":[]},{"name":"in_progress","full_name":"in_progress","description":"\n<p>Match calls that are on-going</p>\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":[]},{"name":"placed_on_hold","full_name":"placed_on_hold","description":"\n<p>Was the call placed on hold?</p>\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":[]},{"name":"has_recording","full_name":"has_recording","description":"\n<p>Match calls that have a recording.</p>\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":[]},{"name":"either_converted","full_name":"either_converted","description":"\n<p>Whether this call&#39;s buyer or traffic source has converted.</p>\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":[]},{"name":"buyer_conversion_duplicated_call","full_name":"buyer_conversion_duplicated_call","description":"\n<p>Match calls where the callerID was a duplicate against the Buyer&#39;s conversion settings.</p>\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":[]},{"name":"offer_conversion_duplicated_call","full_name":"offer_conversion_duplicated_call","description":"\n<p>Match calls where the callerID was a duplicate against the Traffic Source&#39;s conversion settings.</p>\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":[]},{"name":"no_buyer","full_name":"no_buyer","description":"\n<p>Match calls that didn&#39;t connect to a Buyer</p>\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":[]},{"name":"token_key","full_name":"token_key","description":"\n<p>Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value","full_name":"token_value","description":"\n<p>Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n<p>Sort results by this field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>direction</code>, <code>updated_at</code>, <code>start_app_duration</code>, <code>number_id</code>, <code>offer_id</code>, <code>traffic_source_id</code>, <code>sub_id</code>, <code>buyer_id</code>, <code>caller_number</code>, <code>updated_at</code>, <code>total_duration</code>, <code>hold_duration</code>, <code>ivr_duration</code>, <code>third_party_cost</code>, <code>charge_total</code>, <code>answered_duration</code>, <code>agent_duration</code>, <code>status</code>, <code>buyer_converted</code>, <code>revenue</code>, <code>offer_converted</code>, <code>payout</code>, <code>outgoing_webhooks_count</code>, <code>created_at</code>, <code>end_time</code>, <code>lead_id</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_dir","full_name":"order_dir","description":"\n<p>Sort results in ascending or descending order.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>desc</code>, <code>asc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_id","full_name":"number_id","description":"\n<p>Refer to the number api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule internal id.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Refer to the buyer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Buyer Group Internal ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Refer to the Number Pool api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>An Integer number eg: 12345</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Refer to the provider api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_id","full_name":"contact_id","description":"\n<p>Match calls that were placed by this caller.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Match results that have this status.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ended_at_to","full_name":"ended_at_to","description":"\n<p>Date formatted like 2016-01-01 12:00:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ended_at_from","full_name":"ended_at_from","description":"\n<p>Date formatted like 2016-01-01 12:00:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/stats/?group_by=status&created_at_from=2024-11-20 19:27:29 UTC&created_at_to=2024-11-21 07:27:29 +0000&stat=count\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/create","name":"create","apis":[{"api_url":"/api/v1/calls","http_method":"POST","short_description":"Make an outbound phone call.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>call</th><td>Default response format.</td></tr><tr><th>call_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"from","description":"\n<p>The call will originate from this address (+E.164 formatted phone number.) Example: +18665550001</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"to","description":"\n<p>The call will be placed to this receiving address (+E.164 formatted phone number.) Example: +18665550001</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_id","full_name":"lead_id","description":"\n<p>Optional. Associate this call with this lead.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead}[/api/docs/1.0/leads/index.html]. Refer to: {/api/docs/1.0/leads}[/api/docs/1.0/leads/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Optional. If a lead exists on this schedule, this call will be associated with it. If no lead currently exists, one will be created, and it will be added to this schedule.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"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":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Optional. Associate this call with a matching lead on this offer. If no lead currently exists, one will be created on this offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/show","name":"show","apis":[{"api_url":"/api/v1/calls/:id","http_method":"GET","short_description":"Get a call by id or uuid.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>call</th><td>Default response format.</td></tr><tr><th>call_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>Find the call by <code>Call ID</code> or <code>Call UUID</code>. <br>Example ID <code>123895022</code>.<br>Example UUID <code>c3b20b12-3b3b-4322-b15d-0f1c5f653479</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/events","name":"events","apis":[{"api_url":"/api/v1/calls/:id/events","http_method":"GET","short_description":"Advanced Call Analysis provides detailed event logs of telephonic interactions. This feature captures an array of events including call channels, agent interactions, outgoing HTTP requests, buyer pings, call recordings, and more. Each advanced call analysis request incurs a usage charge billed at your account's <a href=\"/monthly_plans/upgrade_plan\">Per Advanced Call Analysis\tRate</a>. The default rate is 0.0002/request.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1/events\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/update","name":"update","apis":[{"api_url":"/api/v1/calls/:id","http_method":"POST","short_description":"Update a call by <code>Call ID</code> or <code>Call UUID</code> with contact fields, revenue, payout, and more.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>call</th><td>Default response format.</td></tr><tr><th>call_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>Find the call by <code>Call ID</code> or <code>Call UUID</code>. <br>Example ID <code>123895022</code>.<br>Example UUID <code>c3b20b12-3b3b-4322-b15d-0f1c5f653479</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_call_tokens","full_name":"post_call_tokens","description":"\n<p>Custom contact fields defined on the offer.<br> EG: <code>{first_name: &quot;John&quot;, last_name: &quot;Smith&quot;, zip_code: &quot;90210&quot;}</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"revenue","description":"\n<p>The revenue paid out for the call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"add_revenue","full_name":"add_revenue","description":"\n<p>Add this amount to the call&#39;s current revenue. For example pass 2.5 to add 2.5 to the current call revenue. If the call revenue is currently 10.50, the revenue would become 13 (10.50 + 2.50)</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"add_payout","full_name":"add_payout","description":"\n<p>Add this amount to the call&#39;s current payout.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n<p>Did the buyer convert?</p>\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":[]},{"name":"trackdrive_buyer_id","full_name":"trackdrive_buyer_id","description":"\n<p>Update the winning Buyer that is assigned to this call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payout","full_name":"payout","description":"\n<p>The amount paid to the traffic source.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_converted","full_name":"offer_converted","description":"\n<p>Did the traffic source convert?</p>\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":[]},{"name":"trackdrive_traffic_source_id","full_name":"trackdrive_traffic_source_id","description":"\n<p>Update the Traffic Source that is assigned to this call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_field_type","full_name":"contact_field_type","description":"\n<p>Pass an ID belonging to an <code>Agent Script &amp; Field Type</code> to select that <code>Custom Contact Field Type</code> for this call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fire_outgoing_webhook_ids","full_name":"fire_outgoing_webhook_ids","description":"\n<p>Manually refire the listed outgoing webhook ids against this call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"manual_transcribe","full_name":"manual_transcribe","description":"\n<p>Manually transcribe this call using the default transcription group.</p>\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":[]},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n<p>Call Disposition</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"agent_call_disposition_notes","full_name":"agent_call_disposition_notes","description":"\n<p>Notes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"post_call_tokens\": {\"good_lead\":\"yes\",\"loan_amount\":\"500\"}}' https://[your-subdomain].trackdrive.com/api/v1/calls/:id"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/update_by_caller_id","name":"update_by_caller_id","apis":[{"api_url":"/api/v1/calls/update_by_caller_id/:caller_id","http_method":"POST","short_description":"Update a call's revenue and buyer_converted using the call's <code>caller_id</code> and <code>offer_token</code>","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_id","full_name":"caller_id","description":"\n<p>The caller ID for the call that will be updated.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_token","full_name":"offer_token","description":"\n<p>The <code>Dynamic Number Insertion</code> token for the offer.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_timeframe","full_name":"call_timeframe","description":"\n<p>Pass this optional parameter to restrict the call update to calls made in the last <code>call_timeframe</code> minutes. For Example: Pass 120 if you&#39;d like to only update calls made in the last 2 hours. This is useful if you only want to update a call that happened recently.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"revenue","description":"\n<p>Set the call&#39;s revenue to this amount. For example pass 10.50 to set the revenue to 10.50</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"add_revenue","full_name":"add_revenue","description":"\n<p>Add this amount to the call&#39;s current revenue. For example pass 2.5 to add 2.5 to the current call revenue. If the call revenue is currently 10.50, the revenue would become 13 (10.50 + 2.50)</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"add_payout","full_name":"add_payout","description":"\n<p>Add this amount to the call&#39;s current payout.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n<p>Call Disposition</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"agent_call_disposition_notes","full_name":"agent_call_disposition_notes","description":"\n<p>Notes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n<p>Did the buyer convert?</p>\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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"add_revenue\": 2.50, \"buyer_converted\": \"true\"}' https://[your-subdomain].trackdrive.com/api/v1/calls/update_by_caller_id/:caller_id","curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X POST \"https://my-company.trackdrive.com/api/v1/calls/update_by_caller_id/17194448888?offer_token=the-offer-token&add_revenue=5\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/send_key_press","name":"send_key_press","apis":[{"api_url":"/api/v1/calls/send_key_press","http_method":"POST","short_description":"Send a Key Press to trigger a key press flow.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Find the call by <code>Call ID</code> or <code>Call UUID</code>. <br>Example ID <code>123895022</code>.<br>Example UUID <code>c3b20b12-3b3b-4322-b15d-0f1c5f653479</code></p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"digits","full_name":"digits","description":"\n<p>DTMF digit</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data","full_name":"data","description":"\n<p>Update the call with this data. <code>{interest: &#39;kittens&#39;, source: &#39;google&#39;, first_name: &#39;John&#39;, last_name: &#39;Smith&#39;}</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"id\": \"fbd28553-04fc-4c6b-9af8-46c17d5925bf\", \"digits\": \"5\", \"data\": {\"first_name\": \"John\"}}' \"https://[your-subdomain].trackdrive.com/api/v1/calls/send_key_press\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/destroy","name":"destroy","apis":[{"api_url":"/api/v1/calls/:id","http_method":"DELETE","short_description":"Hang up an ongoing call.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>call</th><td>Default response format.</td></tr><tr><th>call_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>Find the call by <code>Call ID</code> or <code>Call UUID</code>. <br>Example ID <code>123895022</code>.<br>Example UUID <code>c3b20b12-3b3b-4322-b15d-0f1c5f653479</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -i -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/calls/77777777-dbe3-49ee-b28f-115ec80dcef9\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"change_logs":{"doc_url":"/api/docs/1.0/change_logs","id":"change_logs","api_url":"/api","name":"Audit Logs","short_description":"An audit log of changes to records in your Trackdrive account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/change_logs/index","name":"index","apis":[{"api_url":"/api/v1/change_logs","http_method":"GET","short_description":"List Change Log records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"owner_id","description":"\n<p>The ID for the record that owns this record.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\n<p>The type of record that owns this record.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nemail\n</li>\n<li class='column-attempt'>\nuser_name\n</li>\n<li class='column-attempt'>\nrequest_ip\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\ncall_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\nbuyer_group_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nbatch_action_id\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n<li class='column-attempt'>\nowner_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nadmin_user_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\ncollaborator_id\n</li>\n<li class='column-attempt'>\nparams\n</li>\n<li class='column-attempt'>\nrequest_path\n</li>\n<li class='column-attempt'>\naction_name\n</li>\n<li class='column-attempt'>\ncontroller_name\n</li>\n<li class='column-attempt'>\nrequest_method\n</li>\n<li class='column-attempt'>\nresponse_body\n</li>\n<li class='column-attempt'>\nresponse_status\n</li>\n<li class='column-attempt'>\nuser_agent\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/change_logs/show","name":"show","apis":[{"api_url":"/api/v1/change_logs/:id","http_method":"GET","short_description":"Get Change Log by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"charge_rollups":{"doc_url":"/api/docs/1.0/charge_rollups","id":"charge_rollups","api_url":"/api","name":"Billing","short_description":"API resource for viewing billing information.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/charge_rollups/index","name":"index","apis":[{"api_url":"/api/v1/charge_rollups","http_method":"GET","short_description":"List billing records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\ncharge_type\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\namount\n</li>\n<li class='column-attempt'>\nsms_blast_messages_count\n</li>\n<li class='column-attempt'>\nthird_party_cost\n</li>\n<li class='column-attempt'>\nsms_ai_charges_count\n</li>\n<li class='column-attempt'>\ncharges_count\n</li>\n<li class='column-attempt'>\nclean_number_charges_count\n</li>\n<li class='column-attempt'>\nlead_action_logs_count\n</li>\n<li class='column-attempt'>\ntranscriptions_count\n</li>\n<li class='column-attempt'>\ndnc_check_logs_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"clean_number_lists":{"doc_url":"/api/docs/1.0/clean_number_lists","id":"clean_number_lists","api_url":"/api","name":"TDPN List","short_description":"API resource for managing TDPN List.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/clean_number_lists/index","name":"index","apis":[{"api_url":"/api/v1/clean_number_lists","http_method":"GET","short_description":"List TDPN List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nprefix\n</li>\n<li class='column-attempt'>\nstate\n</li>\n<li class='column-attempt'>\nclean_numbers_count\n</li>\n<li class='column-attempt'>\navailable_numbers_count\n</li>\n<li class='column-attempt'>\nno_numbers_for_sale_at\n</li>\n<li class='column-attempt'>\nrunning_low\n</li>\n<li class='column-attempt'>\nmanual_bulk_order_count\n</li>\n<li class='column-attempt'>\navailable_numbers_percent\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/clean_number_lists/show","name":"show","apis":[{"api_url":"/api/v1/clean_number_lists/:id","http_method":"GET","short_description":"Get TDPN List by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"collaborators":{"doc_url":"/api/docs/1.0/collaborators","id":"collaborators","api_url":"/api","name":"Team Member","short_description":"API resource for managing Team Member.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/collaborators/index","name":"index","apis":[{"api_url":"/api/v1/collaborators","http_method":"GET","short_description":"List Team Member records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nfirst_name\n</li>\n<li class='column-attempt'>\nlast_name\n</li>\n<li class='column-attempt'>\ncompany_name\n</li>\n<li class='column-attempt'>\nemail\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nphone_number\n</li>\n<li class='column-attempt'>\naddress_state\n</li>\n<li class='column-attempt'>\naddress_city\n</li>\n<li class='column-attempt'>\naddress_country\n</li>\n<li class='column-attempt'>\naddress_zip\n</li>\n<li class='column-attempt'>\naddress_line1\n</li>\n<li class='column-attempt'>\naddress_line2\n</li>\n<li class='column-attempt'>\nskype_name\n</li>\n<li class='column-attempt'>\nsoftphone_enabled\n</li>\n<li class='column-attempt'>\nsoftphone_username\n</li>\n<li class='column-attempt'>\nsoftphone_ip\n</li>\n<li class='column-attempt'>\nprovider_configuration_id\n</li>\n<li class='column-attempt'>\nnumber_id\n</li>\n<li class='column-attempt'>\ntoll_free\n</li>\n<li class='column-attempt'>\ncountry\n</li>\n<li class='column-attempt'>\narea_code_id\n</li>\n<li class='column-attempt'>\nagent_number\n</li>\n<li class='column-attempt'>\nagent_enabled\n</li>\n<li class='column-attempt'>\nagent_status_key\n</li>\n<li class='column-attempt'>\ncall_center_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/collaborators/show","name":"show","apis":[{"api_url":"/api/v1/collaborators/:id","http_method":"GET","short_description":"Get Team Member by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"collections":{"doc_url":"/api/docs/1.0/collections","id":"collections","api_url":"/api","name":"Collections","short_description":"Fetch various collections used in the Trackdrive Interface.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/collections/show","name":"show","apis":[{"api_url":"/api/v1/collections/:type","http_method":"GET","short_description":"Get a collection.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"type","full_name":"type","description":"\n<p>The type of collection to return.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>buyer_group_table_details</th><td>Buyer Group Table Details</td></tr><tr><th>buyer_table_details</th><td>Buyer Table Details</td></tr><tr><th>call_buyer_id</th><td>Call Buyer</td></tr><tr><th>call_category</th><td>Call Category</td></tr><tr><th>call_child_buyer_id</th><td>Call Child Buyer</td></tr><tr><th>call_contact_field_type</th><td>Call Contact Field Type</td></tr><tr><th>call_country</th><td>Call Country</td></tr><tr><th>call_hangup_cause_status</th><td>Call Hangup Cause Status</td></tr><tr><th>call_hung_up_by</th><td>Call Hung Up By</td></tr><tr><th>call_offer_id</th><td>Call Offer</td></tr><tr><th>call_report_table_details</th><td>Call Report Table Details</td></tr><tr><th>call_state_province</th><td>Call State Province</td></tr><tr><th>call_status</th><td>Call Status</td></tr><tr><th>call_sub_id</th><td>Call Sub</td></tr><tr><th>call_table_details</th><td>Call Table Details</td></tr><tr><th>call_token_values_map</th><td>Call Token Values Map</td></tr><tr><th>call_zip_postal_code</th><td>Zip / Postal Codes On Calls</td></tr><tr><th>countries</th><td>Countries</td></tr><tr><th>facet_categories</th><td>Facet Categories</td></tr><tr><th>lead_contact_field_type</th><td>Lead Contact Field Type</td></tr><tr><th>lead_country</th><td>Lead Country</td></tr><tr><th>lead_dial_number_id</th><td>Lead Dial Number</td></tr><tr><th>lead_dial_tier</th><td>Lead Dial Tier</td></tr><tr><th>lead_lead_import_id</th><td>Lead Lead Import</td></tr><tr><th>lead_report_table_details</th><td>Lead Report Table Details</td></tr><tr><th>lead_schedule_trigger_type</th><td>Lead Schedule Trigger Type</td></tr><tr><th>lead_sms_number_id</th><td>Lead Sms Number</td></tr><tr><th>lead_state_province</th><td>Lead State Province</td></tr><tr><th>lead_status</th><td>Lead Status</td></tr><tr><th>lead_status</th><td>Lead Status</td></tr><tr><th>lead_sub_id</th><td>Lead Sub</td></tr><tr><th>lead_table_details</th><td>Lead Table Details</td></tr><tr><th>lead_token_values_map</th><td>Lead Token Values Map</td></tr><tr><th>lead_zip_postal_code</th><td>Lead Zip Postal Code</td></tr><tr><th>number_table_details</th><td>Number Table Details</td></tr><tr><th>offer_table_details</th><td>Offer Table Details</td></tr><tr><th>ring_pool_table_details</th><td>Ring Pool Table Details</td></tr><tr><th>schedule_table_details</th><td>Schedule Table Details</td></tr><tr><th>states</th><td>States</td></tr><tr><th>time_zone</th><td>Time Zone</td></tr><tr><th>traffic_source_table_details</th><td>Traffic Source Table Details</td></tr><tr><th>webhook_ips</th><td>Webhook Ips</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_label","full_name":"created_at_label","description":"\n<p>Dynamic Date String such as “Today” or “This Year”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>Last 5 Min</code>, <code>Last 15 Min</code>, <code>Last 30 Min</code>, <code>Last Hour</code>, <code>Last 4 Hours</code>, <code>Last 6 Hours</code>, <code>Last 12 Hours</code>, <code>Last Day</code>, <code>Last 2 Days</code>, <code>Today</code>, <code>Yesterday</code>, <code>This Week</code>, <code>Last Week</code>, <code>This Month</code>, <code>Last Month</code>, <code>This Quarter</code>, <code>Last Quarter</code>, <code>Last 6 Months</code>, <code>This Year</code>, <code>Last Year</code>, <code>Lifetime</code>, <code>Custom Range</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"query","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"companies":{"doc_url":"/api/docs/1.0/companies","id":"companies","api_url":"/api","name":"Your Companies","short_description":"API resource for viewing the Trackdrive Companies you can access.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/companies/index","name":"index","apis":[{"api_url":"/api/v1/companies","http_method":"GET","short_description":"List the Trackdrive Companies you can access.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nemail\n</li>\n<li class='column-attempt'>\nsubdomain_url\n</li>\n<li class='column-attempt'>\nsubdomain\n</li>\n<li class='column-attempt'>\nuser_name\n</li>\n<li class='column-attempt'>\nbalance\n</li>\n<li class='column-attempt'>\nbackground_color\n</li>\n<li class='column-attempt'>\ntext_color\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/companies/show","name":"show","apis":[{"api_url":"/api/v1/companies/:id","http_method":"GET","short_description":"Get Company by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"company_access_tokens":{"doc_url":"/api/docs/1.0/company_access_tokens","id":"company_access_tokens","api_url":"/api","name":"Access Tokens","short_description":"API resource for managing Access Tokens.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/company_access_tokens/index","name":"index","apis":[{"api_url":"/api/v1/company_access_tokens","http_method":"GET","short_description":"List Access Tokens records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\npublic_key\n</li>\n<li class='column-attempt'>\nprivate_key\n</li>\n<li class='column-attempt'>\nexample_authorization_header\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\ndata_access_type\n</li>\n<li class='column-attempt'>\ncollaborator_id\n</li>\n<li class='column-attempt'>\nlast_used_at\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\npermit_all\n</li>\n<li class='column-attempt'>\npermit_teams\n</li>\n<li class='column-attempt'>\npermit_agents\n</li>\n<li class='column-attempt'>\npermit_billing\n</li>\n<li class='column-attempt'>\npermit_buyers\n</li>\n<li class='column-attempt'>\npermit_offers\n</li>\n<li class='column-attempt'>\npermit_calls\n</li>\n<li class='column-attempt'>\npermit_change_logs\n</li>\n<li class='column-attempt'>\npermit_suppression_list\n</li>\n<li class='column-attempt'>\npermit_incoming_text_messages\n</li>\n<li class='column-attempt'>\npermit_leads\n</li>\n<li class='column-attempt'>\npermit_phone_numbers\n</li>\n<li class='column-attempt'>\npermit_ring_pools\n</li>\n<li class='column-attempt'>\npermit_schedules\n</li>\n<li class='column-attempt'>\npermit_scheduled_callbacks\n</li>\n<li class='column-attempt'>\npermit_sound_files\n</li>\n<li class='column-attempt'>\npermit_text_messages\n</li>\n<li class='column-attempt'>\npermit_traffic_sources\n</li>\n<li class='column-attempt'>\npermit_virtual_numbers\n</li>\n<li class='column-attempt'>\npermit_webhook_logs\n</li>\n<li class='column-attempt'>\npermit_zip_code_lists\n</li>\n<li class='column-attempt'>\npermit_call_recordings\n</li>\n<li class='column-attempt'>\npermit_data_appends\n</li>\n<li class='column-attempt'>\nmonthly_request_count\n</li>\n<li class='column-attempt'>\nyearly_request_count\n</li>\n<li class='column-attempt'>\ntotal_request_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/new","name":"new","apis":[{"api_url":"/api/v1/company_access_tokens/new","http_method":"GET","short_description":"Build Access Tokens with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"public_key","full_name":"public_key","description":"\n<p>Public Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"private_key","full_name":"private_key","description":"\n<p>Private Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_used_at","full_name":"last_used_at","description":"\n<p>Last Used At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"permissions","full_name":"permissions","description":"\n<p>Permissions</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/create","name":"create","apis":[{"api_url":"/api/v1/company_access_tokens","http_method":"POST","short_description":"Create Access Tokens.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"public_key","full_name":"public_key","description":"\n<p>Public Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"private_key","full_name":"private_key","description":"\n<p>Private Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_used_at","full_name":"last_used_at","description":"\n<p>Last Used At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"permissions","full_name":"permissions","description":"\n<p>Permissions</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/show","name":"show","apis":[{"api_url":"/api/v1/company_access_tokens/:id","http_method":"GET","short_description":"Get Access Tokens by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/update","name":"update","apis":[{"api_url":"/api/v1/company_access_tokens/:id","http_method":"PUT","short_description":"Update Access Tokens by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"public_key","full_name":"public_key","description":"\n<p>Public Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"private_key","full_name":"private_key","description":"\n<p>Private Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_used_at","full_name":"last_used_at","description":"\n<p>Last Used At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"permissions","full_name":"permissions","description":"\n<p>Permissions</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/v1/company_access_tokens/:id","http_method":"DELETE","short_description":"Destroy Access Tokens by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"company_dialler_processors":{"doc_url":"/api/docs/1.0/company_dialler_processors","id":"company_dialler_processors","api_url":"/api","name":"Power Dialer","short_description":"API resource for managing Power Dialer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/company_dialler_processors/show","name":"show","apis":[{"api_url":"/api/v1/company_dialler_processors/:id","http_method":"GET","short_description":"Get Power Dialer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_dialler_processors/update","name":"update","apis":[{"api_url":"/api/v1/company_dialler_processors/:id","http_method":"PUT","short_description":"Translation missing: en.api.company_dialler_processors.update","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"company_feature_fields":{"doc_url":"/api/docs/1.0/company_feature_fields","id":"company_feature_fields","api_url":"/api","name":"Feature","short_description":"API resource for managing Feature.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/company_feature_fields/index","name":"index","apis":[{"api_url":"/api/v1/company_feature_fields","http_method":"GET","short_description":"List Feature records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nfield_name\n</li>\n<li class='column-attempt'>\nenabled\n</li>\n<li class='column-attempt'>\nfield_name_label\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nfield_name_help\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_feature_fields/show","name":"show","apis":[{"api_url":"/api/v1/company_feature_fields/:id","http_method":"GET","short_description":"Get Feature by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_feature_fields/update","name":"update","apis":[{"api_url":"/api/v1/company_feature_fields/:id","http_method":"PUT","short_description":"Update feature by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"company_report_fields":{"doc_url":"/api/docs/1.0/company_report_fields","id":"company_report_fields","api_url":"/api","name":"Report Field","short_description":"API resource for managing Report Field.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/company_report_fields/index","name":"index","apis":[{"api_url":"/api/v1/company_report_fields","http_method":"GET","short_description":"List Report Field records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nrails_model_name\n</li>\n<li class='column-attempt'>\nfield_name\n</li>\n<li class='column-attempt'>\nfield_name_human\n</li>\n<li class='column-attempt'>\nenabled\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_report_fields/show","name":"show","apis":[{"api_url":"/api/v1/company_report_fields/:id","http_method":"GET","short_description":"Get Report Field by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_report_fields/update","name":"update","apis":[{"api_url":"/api/v1/company_report_fields/:id","http_method":"PUT","short_description":"Update Report Field by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contact_field_migrators":{"doc_url":"/api/docs/1.0/contact_field_migrators","id":"contact_field_migrators","api_url":"/api","name":"Contact Field Migrator","short_description":"API resource for managing Contact Field Migrator.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contact_field_migrators/index","name":"index","apis":[{"api_url":"/api/v1/contact_field_migrators","http_method":"GET","short_description":"List Contact Field Migrator records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsource_company_id\n</li>\n<li class='column-attempt'>\ntarget_company_id\n</li>\n<li class='column-attempt'>\nsource_offer_id\n</li>\n<li class='column-attempt'>\ntarget_offer_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_migrators/new","name":"new","apis":[{"api_url":"/api/v1/contact_field_migrators/new","http_method":"GET","short_description":"Build Contact Field Migrator with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_migrators/create","name":"create","apis":[{"api_url":"/api/v1/contact_field_migrators","http_method":"POST","short_description":"Create Contact Field Migrator.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_migrators/show","name":"show","apis":[{"api_url":"/api/v1/contact_field_migrators/:id","http_method":"GET","short_description":"Get Contact Field Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_migrators/update","name":"update","apis":[{"api_url":"/api/v1/contact_field_migrators/:id","http_method":"PUT","short_description":"Update Contact Field Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_migrators/destroy","name":"destroy","apis":[{"api_url":"/api/v1/contact_field_migrators/:id","http_method":"DELETE","short_description":"Destroy Contact Field Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contact_field_values":{"doc_url":"/api/docs/1.0/contact_field_values","id":"contact_field_values","api_url":"/api","name":"Offers: Contact Fields: Picklist Values","short_description":"API resource for managing a contact field's picklist values.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contact_field_values/index","name":"index","apis":[{"api_url":"/api/v1/contact_field_values","http_method":"GET","short_description":"List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"contact_field_id","full_name":"contact_field_id","description":"\n<p>Translation missing: en.api.contact_field_values.contact_field_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Contact Field}[/api/docs/1.0/contact_fields/index.html]. Refer to: {/api/docs/1.0/contact_fields}[/api/docs/1.0/contact_fields/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontact_field_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nvalue\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/new","name":"new","apis":[{"api_url":"/api/v1/contact_field_values/new","http_method":"GET","short_description":"Build record with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"contact_field_id","full_name":"contact_field_id","description":"\n<p>Assign the record to this Contact Field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Contact Field}[/api/docs/1.0/contact_fields/index.html]. Refer to: {/api/docs/1.0/contact_fields}[/api/docs/1.0/contact_fields/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Display Name For Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/create","name":"create","apis":[{"api_url":"/api/v1/contact_field_values","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"contact_field_id","full_name":"contact_field_id","description":"\n<p>Assign the record to this Contact Field.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Contact Field}[/api/docs/1.0/contact_fields/index.html]. Refer to: {/api/docs/1.0/contact_fields}[/api/docs/1.0/contact_fields/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Display Name For Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/show","name":"show","apis":[{"api_url":"/api/v1/contact_field_values/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/update","name":"update","apis":[{"api_url":"/api/v1/contact_field_values/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"contact_field_id","full_name":"contact_field_id","description":"\n<p>Assign the record to this Contact Field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Contact Field}[/api/docs/1.0/contact_fields/index.html]. Refer to: {/api/docs/1.0/contact_fields}[/api/docs/1.0/contact_fields/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Display Name For Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/destroy","name":"destroy","apis":[{"api_url":"/api/v1/contact_field_values/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contact_field_views":{"doc_url":"/api/docs/1.0/contact_field_views","id":"contact_field_views","api_url":"/api","name":"Offers: Agent Scripts","short_description":"API resource for managing an offer's agent scripts.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contact_field_views/index","name":"index","apis":[{"api_url":"/api/v1/contact_field_views","http_method":"GET","short_description":"List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.contact_field_views.offer_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nscript_javascript\n</li>\n<li class='column-attempt'>\njornaya_campaign_id\n</li>\n<li class='column-attempt'>\nfields_type\n</li>\n<li class='column-attempt'>\ntitle\n</li>\n<li class='column-attempt'>\nscript_html\n</li>\n<li class='column-attempt'>\ntoken_keys\n</li>\n<li class='column-attempt'>\nis_default\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nuse_when_tokens_match\n</li>\n<li class='column-attempt'>\ntemplate_description\n</li>\n<li class='column-attempt'>\ntemplate_enabled\n</li>\n<li class='column-attempt'>\ntemplate_tier\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/new","name":"new","apis":[{"api_url":"/api/v1/contact_field_views/new","http_method":"GET","short_description":"Build record with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"title","full_name":"title","description":"\n<p>Agent Script Display Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields_type","full_name":"fields_type","description":"\n<p>A unique value that will be submitted with leads to select this field type and agent script.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"script_html","full_name":"script_html","description":"\n<p>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.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_keys","full_name":"token_keys","description":"\n<p>These fields will be visible when this field_type is selected.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/create","name":"create","apis":[{"api_url":"/api/v1/contact_field_views","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"title","full_name":"title","description":"\n<p>Agent Script Display Name</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields_type","full_name":"fields_type","description":"\n<p>A unique value that will be submitted with leads to select this field type and agent script.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"script_html","full_name":"script_html","description":"\n<p>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.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_keys","full_name":"token_keys","description":"\n<p>These fields will be visible when this field_type is selected.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/show","name":"show","apis":[{"api_url":"/api/v1/contact_field_views/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/update","name":"update","apis":[{"api_url":"/api/v1/contact_field_views/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"title","full_name":"title","description":"\n<p>Agent Script Display Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fields_type","full_name":"fields_type","description":"\n<p>A unique value that will be submitted with leads to select this field type and agent script.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"script_html","full_name":"script_html","description":"\n<p>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.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_keys","full_name":"token_keys","description":"\n<p>These fields will be visible when this field_type is selected.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/destroy","name":"destroy","apis":[{"api_url":"/api/v1/contact_field_views/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contact_fields":{"doc_url":"/api/docs/1.0/contact_fields","id":"contact_fields","api_url":"/api","name":"Offers: Contact Fields","short_description":"API resource for managing an offer's contact fields.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contact_fields/index","name":"index","apis":[{"api_url":"/api/v1/contact_fields","http_method":"GET","short_description":"List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>contact_field</th><td>Contact Field</td></tr><tr><th>contact_field_form</th><td>Contact Field Form</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nrequired\n</li>\n<li class='column-attempt'>\nrequired_on_create\n</li>\n<li class='column-attempt'>\nrequired_on_ping\n</li>\n<li class='column-attempt'>\ntoken_id\n</li>\n<li class='column-attempt'>\ncheck_buyer_filters_before_calling\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nhint\n</li>\n<li class='column-attempt'>\nvalue_type\n</li>\n<li class='column-attempt'>\nvalue_formatter\n</li>\n<li class='column-attempt'>\nvalue_expression\n</li>\n<li class='column-attempt'>\nhtml_id\n</li>\n<li class='column-attempt'>\ncontact_field_value_ids\n</li>\n<li class='column-attempt'>\nshow_in_docs\n</li>\n<li class='column-attempt'>\nshow_in_tables\n</li>\n<li class='column-attempt'>\nshow_in_reports\n</li>\n<li class='column-attempt'>\nvalue_decimal_min\n</li>\n<li class='column-attempt'>\nvalue_decimal_max\n</li>\n<li class='column-attempt'>\ndecimal_places\n</li>\n<li class='column-attempt'>\ninclude_blank\n</li>\n<li class='column-attempt'>\nboolean_true_text\n</li>\n<li class='column-attempt'>\nboolean_false_text\n</li>\n<li class='column-attempt'>\nbackground_color\n</li>\n<li class='column-attempt'>\ntext_color\n</li>\n<li class='column-attempt'>\ncontact_field_values_type\n</li>\n<li class='column-attempt'>\ncheck_buyer_filters_allow_blank\n</li>\n<li class='column-attempt'>\nvalue_pattern_validation\n</li>\n<li class='column-attempt'>\ncheck_pattern_validation\n</li>\n<li class='column-attempt'>\ncontact_field_values_count\n</li>\n<li class='column-attempt'>\ndate_picker_in_future\n</li>\n<li class='column-attempt'>\ndate_picker_enabled\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/new","name":"new","apis":[{"api_url":"/api/v1/contact_fields/new","http_method":"GET","short_description":"Build record with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>The internal token name where values are stored.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"required","description":"\n<p>Is this field required?</p>\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":[]},{"name":"name","full_name":"name","description":"\n<p>The friendly human name displayed to users.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Display a helpful hint to users explaining the purpose of this field.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"value_type","description":"\n<p>Field Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>, <code>expression</code>, <code>hidden</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"decimal_places","full_name":"decimal_places","description":"\n<p>Decimal values/expressions will be rounded to this many decimal places.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Expression Formatter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\n<p>Expression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/create","name":"create","apis":[{"api_url":"/api/v1/contact_fields","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>The internal token name where values are stored.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"required","description":"\n<p>Is this field required?</p>\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":[]},{"name":"name","full_name":"name","description":"\n<p>The friendly human name displayed to users.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Display a helpful hint to users explaining the purpose of this field.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"value_type","description":"\n<p>Field Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>, <code>expression</code>, <code>hidden</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"decimal_places","full_name":"decimal_places","description":"\n<p>Decimal values/expressions will be rounded to this many decimal places.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Expression Formatter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\n<p>Expression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/show","name":"show","apis":[{"api_url":"/api/v1/contact_fields/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/update","name":"update","apis":[{"api_url":"/api/v1/contact_fields/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>The internal token name where values are stored.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"required","description":"\n<p>Is this field required?</p>\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":[]},{"name":"name","full_name":"name","description":"\n<p>The friendly human name displayed to users.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\n<p>Display a helpful hint to users explaining the purpose of this field.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"value_type","description":"\n<p>Field Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>, <code>expression</code>, <code>hidden</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"decimal_places","full_name":"decimal_places","description":"\n<p>Decimal values/expressions will be rounded to this many decimal places.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Expression Formatter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\n<p>Expression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/destroy","name":"destroy","apis":[{"api_url":"/api/v1/contact_fields/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contact_imports":{"doc_url":"/api/docs/1.0/contact_imports","id":"contact_imports","api_url":"/api","name":"Blacklist: Files","short_description":"API resource for uploading blacklist files.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contact_imports/index","name":"index","apis":[{"api_url":"/api/v1/contact_imports","http_method":"GET","short_description":"List Blacklist File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\ndata_maps_set\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nimport_file_url\n</li>\n<li class='column-attempt'>\ndata_json\n</li>\n<li class='column-attempt'>\nerror_message\n</li>\n<li class='column-attempt'>\nimport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nstopped_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nunblock_started_at\n</li>\n<li class='column-attempt'>\nunblock_finished_at\n</li>\n<li class='column-attempt'>\napply_block_or_unblock\n</li>\n<li class='column-attempt'>\nselect_import_type\n</li>\n<li class='column-attempt'>\nimport_file_blob\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nheaders\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_imports/new","name":"new","apis":[{"api_url":"/api/v1/contact_imports/new","http_method":"GET","short_description":"Build Blacklist File with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Translation missing: en.api.contact_imports.import_file</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n<p>Apply Block Or Unblock</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>block</code>, <code>unblock</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"select_import_type","full_name":"select_import_type","description":"\n<p>Upload Import File Or Text</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>file</code>, <code>text_blob</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file_blob","full_name":"import_file_blob","description":"\n<p>Text Blob</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_imports/create","name":"create","apis":[{"api_url":"/api/v1/contact_imports","http_method":"POST","short_description":"Create Blacklist File.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Translation missing: en.api.contact_imports.import_file</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n<p>Apply Block Or Unblock</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>block</code>, <code>unblock</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"select_import_type","full_name":"select_import_type","description":"\n<p>Upload Import File Or Text</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>file</code>, <code>text_blob</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file_blob","full_name":"import_file_blob","description":"\n<p>Text Blob</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_imports/show","name":"show","apis":[{"api_url":"/api/v1/contact_imports/:id","http_method":"GET","short_description":"Get Blacklist File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_imports/update","name":"update","apis":[{"api_url":"/api/v1/contact_imports/:id","http_method":"PUT","short_description":"Update Blacklist File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Translation missing: en.api.contact_imports.import_file</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n<p>Apply Block Or Unblock</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>block</code>, <code>unblock</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"select_import_type","full_name":"select_import_type","description":"\n<p>Upload Import File Or Text</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>file</code>, <code>text_blob</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file_blob","full_name":"import_file_blob","description":"\n<p>Text Blob</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contacts":{"doc_url":"/api/docs/1.0/contacts","id":"contacts","api_url":"/api","name":"Contacts & Blacklist","short_description":"The contacts that have dialed your numbers.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contacts/index_suppression_list","name":"index_suppression_list","apis":[{"api_url":"/api/v1/contacts/suppression_list","http_method":"GET","short_description":"List contacts on your company blacklist.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nnumber\n</li>\n<li class='column-attempt'>\nlast_call_at\n</li>\n<li class='column-attempt'>\nblocked\n</li>\n<li class='column-attempt'>\nopt_out\n</li>\n<li class='column-attempt'>\ncalls_count\n</li>\n<li class='column-attempt'>\noutbound_call_failure_count\n</li>\n<li class='column-attempt'>\noutbound_no_answer_count\n</li>\n<li class='column-attempt'>\nblocked_at\n</li>\n<li class='column-attempt'>\nsms_opt_out_at\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/caller_block","name":"caller_block","apis":[{"api_url":"/api/v1/contacts/:caller_id/caller_block","http_method":"POST","short_description":"Add a caller_id to your company blacklist, preventing all inbound and outbound interactions.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X POST -d '' trackdrive.com/api/v1/contacts/17193132645/caller_block"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/caller_unblock","name":"caller_unblock","apis":[{"api_url":"/api/v1/contacts/:caller_id/caller_unblock","http_method":"POST","short_description":"Remove a caller from your company blacklist.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X POST -d '' trackdrive.com/api/v1/contacts/17193132645/caller_unblock"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/show","name":"show","apis":[{"api_url":"/api/v1/contacts/:id","http_method":"GET","short_description":"Get details about a contact.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Lookup a contact by internal id, or by the 10+ digit telephone number. For example:<br> To find a number using trackdrive&#39;s internal id pass <code>id=185923</code><br> To find a number using the phone number pass <code>id=18005002562</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"blocked","full_name":"blocked","description":"\n<p>Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls &amp; sms.</p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/update","name":"update","apis":[{"api_url":"/api/v1/contacts/:id","http_method":"PUT","short_description":"Update a contact","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Lookup a contact by internal id, or by the 10+ digit telephone number. For example:<br> To find a number using trackdrive&#39;s internal id pass <code>id=185923</code><br> To find a number using the phone number pass <code>id=18005002562</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"opt_out","full_name":"opt_out","description":"\n<p>Mark a contact as opt-out or opt-in. Opt-out prevents outbound actions (calls, sms, emails), but allows the lead to dial in to your offers to resubscribe.</p>\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":[]},{"name":"blocked","full_name":"blocked","description":"\n<p>Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls &amp; sms.</p>\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":[]}],"returns":[],"examples":["\ncurl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X PUT \"trackdrive.com/api/v1/contacts/18551231234?blocked=true\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/hang_up_calls","name":"hang_up_calls","apis":[{"api_url":"/api/v1/contacts/:id/calls","http_method":"DELETE","short_description":"Hang up all the ongoing calls from a contact.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"uuid","full_name":"uuid","description":"\n<p>A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -i -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/contacts/123/calls?\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"data_append_groups":{"doc_url":"/api/docs/1.0/data_append_groups","id":"data_append_groups","api_url":"/api","name":"Data Append Group","short_description":"API resource for managing Data Append Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/data_append_groups/index","name":"index","apis":[{"api_url":"/api/v1/data_append_groups","http_method":"GET","short_description":"List Data Append Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ndata_appends_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_append_groups/new","name":"new","apis":[{"api_url":"/api/v1/data_append_groups/new","http_method":"GET","short_description":"Build Data Append Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_append_groups/create","name":"create","apis":[{"api_url":"/api/v1/data_append_groups","http_method":"POST","short_description":"Create Data Append Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_append_groups/show","name":"show","apis":[{"api_url":"/api/v1/data_append_groups/:id","http_method":"GET","short_description":"Get Data Append Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_append_groups/update","name":"update","apis":[{"api_url":"/api/v1/data_append_groups/:id","http_method":"PUT","short_description":"Update Data Append Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_append_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/data_append_groups/:id","http_method":"DELETE","short_description":"Destroy Data Append Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"data_appends":{"doc_url":"/api/docs/1.0/data_appends","id":"data_appends","api_url":"/api","name":"Data Append","short_description":"API resource for appending data. This incurs a per API request usage charge on your company.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/data_appends/index","name":"index","apis":[{"api_url":"/api/v1/data_appends","http_method":"GET","short_description":"List of data appends.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\ndata_append_group_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nappend_type\n</li>\n<li class='column-attempt'>\noverride_data\n</li>\n<li class='column-attempt'>\nmap_contact_field_group_ids\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/new","name":"new","apis":[{"api_url":"/api/v1/data_appends/new","http_method":"GET","short_description":"Build a new data append with default attributes.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_data","full_name":"override_data","description":"\n<p>Override Existing Data</p>\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":[]},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n<p>Map Contact Field Group IDs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n<p>Data Append Group ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"append_type","full_name":"append_type","description":"\n<p>Append Type</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>free_zip_code</th><td>Free Zip Code</td></tr><tr><th>zip_code</th><td>Advanced Zip Code</td></tr><tr><th>address</th><td>Address Data</td></tr><tr><th>contact</th><td>Contact Data</td></tr><tr><th>contact_plus</th><td>Contact+ Data</td></tr><tr><th>all</th><td>All Data</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/create","name":"create","apis":[{"api_url":"/api/v1/data_appends","http_method":"POST","short_description":"Create a data append.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_data","full_name":"override_data","description":"\n<p>Override Existing Data</p>\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":[]},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n<p>Map Contact Field Group IDs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n<p>Data Append Group ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"append_type","full_name":"append_type","description":"\n<p>Append Type</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>free_zip_code</th><td>Free Zip Code</td></tr><tr><th>zip_code</th><td>Advanced Zip Code</td></tr><tr><th>address</th><td>Address Data</td></tr><tr><th>contact</th><td>Contact Data</td></tr><tr><th>contact_plus</th><td>Contact+ Data</td></tr><tr><th>all</th><td>All Data</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/show","name":"show","apis":[{"api_url":"/api/v1/data_appends/:id","http_method":"GET","short_description":"Get details about a data append.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/update","name":"update","apis":[{"api_url":"/api/v1/data_appends/:id","http_method":"PUT","short_description":"Update a data append.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_data","full_name":"override_data","description":"\n<p>Override Existing Data</p>\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":[]},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n<p>Map Contact Field Group IDs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n<p>Data Append Group ID</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"append_type","full_name":"append_type","description":"\n<p>Append Type</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>free_zip_code</th><td>Free Zip Code</td></tr><tr><th>zip_code</th><td>Advanced Zip Code</td></tr><tr><th>address</th><td>Address Data</td></tr><tr><th>contact</th><td>Contact Data</td></tr><tr><th>contact_plus</th><td>Contact+ Data</td></tr><tr><th>all</th><td>All Data</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/destroy","name":"destroy","apis":[{"api_url":"/api/v1/data_appends/:id","http_method":"DELETE","short_description":"Destroy a data append.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/append","name":"append","apis":[{"api_url":"/api/v1/data_append","http_method":"POST","short_description":"Request data for caller number. This incurs a per API request usage charge on your company based on data type requested.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_number","full_name":"caller_number","description":"\n<p>The caller number to retrieve data for.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fetch_type","full_name":"fetch_type","description":"\n<p>The type of data retrieval to perform. This incurs a per API request usage charge on your company based on append type, with the exception of free_zip_code.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>free_zip_code</code>, <code>zip_code</code>, <code>address</code>, <code>contact</code>, <code>contact_plus</code>, <code>all</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"columns","description":"\n<p>Specify the columns you would like returned, e.g. columns=zip_code,city,state</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["# Submit data append request as JSON:\ncurl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \\\n     -H \"Content-Type: application/json\" \\\n     -X POST \\\n     -d '{\"caller_id\":\"+18004506787\",\"fetch_type\":\"address\"}' \\\n     \"https://[your-subdomain].trackdrive.com/api/v1/data_append\"\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"data_export_records":{"doc_url":"/api/docs/1.0/data_export_records","id":"data_export_records","api_url":"/api","name":"Data Exports: Parts","short_description":"API resource for managing Data Export Parts.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/data_export_records/index","name":"index","apis":[{"api_url":"/api/v1/data_export_records","http_method":"GET","short_description":"List Data Export Parts records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\ndata_export_id\n</li>\n<li class='column-attempt'>\npage\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nexport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\nexport_file_url\n</li>\n<li class='column-attempt'>\nexport_duration\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_export_records/show","name":"show","apis":[{"api_url":"/api/v1/data_export_records/:id","http_method":"GET","short_description":"Get Data Export Parts by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"datasets":{"doc_url":"/api/docs/1.0/datasets","id":"datasets","api_url":"/api","name":"Datasets","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/datasets/points","name":"points","apis":[{"api_url":"/api/v1/datasets","http_method":"GET","short_description":"Get datasets","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"from","full_name":"from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rollup_period","full_name":"rollup_period","description":"\n<p>The interval.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rollup_aggregator","full_name":"rollup_aggregator","description":"\n<p>The function to apply to the result set.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>sum</code>, <code>min</code>, <code>max</code>, <code>avg</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Refer to the buyer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"queries","full_name":"queries","description":"\n<p>Translation missing: en.api.datasets.queries</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a a valid array of queries.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"series_calc_function","full_name":"series_calc_function","description":"\n<p>Translation missing: en.api.datasets.series_calc_function</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>timeseries</code>, <code>sum</code>, <code>avg</code>, <code>min</code>, <code>max</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"html_links","full_name":"html_links","description":"\n<p>Translation missing: en.api.datasets.html_links</p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/datasets/calls","name":"calls","apis":[{"api_url":"/api/v1/datasets/calls/:stat","http_method":"GET","short_description":"Get call datasets","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"stat","full_name":"stat","description":"\n<p>Return statistics on the grouped calls by one of these numeric columns.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>buyer_converted_count</code>, <code>offer_converted_count</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_format","full_name":"data_format","description":"\n<p>Translation missing: en.api.data_format</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>timeseries</code>, <code>sum</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n<p>A timeframe</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>300</code>, <code>600</code>, <code>1200</code>, <code>3600</code>, <code>86400</code>, <code>2629746</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/datasets/leads","name":"leads","apis":[{"api_url":"/api/v1/datasets/leads/:stat","http_method":"GET","short_description":"Get call datasets","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"stat","full_name":"stat","description":"\n<p>Translation missing: en.api.leads.stat</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>has_next_action_count</code>, <code>buyer_converted_count</code>, <code>offer_converted_count</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_format","full_name":"data_format","description":"\n<p>Translation missing: en.api.data_format</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>timeseries</code>, <code>sum</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n<p>A timeframe</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>300</code>, <code>600</code>, <code>1200</code>, <code>3600</code>, <code>86400</code>, <code>2629746</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/datasets/billing","name":"billing","apis":[{"api_url":"/api/v1/datasets/billing","http_method":"GET","short_description":"Get the billing dataset","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"data_format","full_name":"data_format","description":"\n<p>Translation missing: en.api.data_format</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>timeseries</code>, <code>sum</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n<p>A timeframe</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>300</code>, <code>600</code>, <code>1200</code>, <code>3600</code>, <code>86400</code>, <code>2629746</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/datasets/number_impressions","name":"number_impressions","apis":[{"api_url":"/api/v1/datasets/number_impressions","http_method":"GET","short_description":"Get the number impression dataset","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"data_format","full_name":"data_format","description":"\n<p>Translation missing: en.api.data_format</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>timeseries</code>, <code>sum</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n<p>A timeframe</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>300</code>, <code>600</code>, <code>1200</code>, <code>3600</code>, <code>86400</code>, <code>2629746</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_platforms":{"doc_url":"/api/docs/1.0/external_platforms","id":"external_platforms","api_url":"/api","name":"External Platform","short_description":"API resource for managing External Platform.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/external_platforms/index","name":"index","apis":[{"api_url":"/api/v1/external_platforms","http_method":"GET","short_description":"List External Platform records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nplatform_type\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nsip_endpoint\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nsip_endpoint_enabled\n</li>\n<li class='column-attempt'>\nabsolute_codec_string\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/external_platforms/new","name":"new","apis":[{"api_url":"/api/v1/external_platforms/new","http_method":"GET","short_description":"Build External Platform with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/external_platforms/create","name":"create","apis":[{"api_url":"/api/v1/external_platforms","http_method":"POST","short_description":"Create External Platform.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/external_platforms/show","name":"show","apis":[{"api_url":"/api/v1/external_platforms/:id","http_method":"GET","short_description":"Get External Platform by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/external_platforms/update","name":"update","apis":[{"api_url":"/api/v1/external_platforms/:id","http_method":"PUT","short_description":"Update External Platform by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"filter_group_items":{"doc_url":"/api/docs/1.0/filter_group_items","id":"filter_group_items","api_url":"/api","name":"Filter Set Rule","short_description":"API resource for managing Filter Set Rule.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/filter_group_items/index","name":"index","apis":[{"api_url":"/api/v1/filter_group_items","http_method":"GET","short_description":"List Filter Set Rule records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nfilter_group_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/new","name":"new","apis":[{"api_url":"/api/v1/filter_group_items/new","http_method":"GET","short_description":"Build Filter Set Rule with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Filter Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Translation missing: en.api.filter_group_items.record_token_filter_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.filter_group_items.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/create","name":"create","apis":[{"api_url":"/api/v1/filter_group_items","http_method":"POST","short_description":"Create Filter Set Rule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Filter Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Translation missing: en.api.filter_group_items.record_token_filter_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.filter_group_items.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/show","name":"show","apis":[{"api_url":"/api/v1/filter_group_items/:id","http_method":"GET","short_description":"Get Filter Set Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/update","name":"update","apis":[{"api_url":"/api/v1/filter_group_items/:id","http_method":"PUT","short_description":"Update Filter Set Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Filter Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Translation missing: en.api.filter_group_items.record_token_filter_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.filter_group_items.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/destroy","name":"destroy","apis":[{"api_url":"/api/v1/filter_group_items/:id","http_method":"DELETE","short_description":"Destroy Filter Set Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"filter_groups":{"doc_url":"/api/docs/1.0/filter_groups","id":"filter_groups","api_url":"/api","name":"Filter Set","short_description":"API resource for managing Filter Set.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/filter_groups/index","name":"index","apis":[{"api_url":"/api/v1/filter_groups","http_method":"GET","short_description":"List Filter Set records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nmatch_type\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nfilter_group_items_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/new","name":"new","apis":[{"api_url":"/api/v1/filter_groups/new","http_method":"GET","short_description":"Build Filter Set with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/create","name":"create","apis":[{"api_url":"/api/v1/filter_groups","http_method":"POST","short_description":"Create Filter Set.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/show","name":"show","apis":[{"api_url":"/api/v1/filter_groups/:id","http_method":"GET","short_description":"Get Filter Set by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/update","name":"update","apis":[{"api_url":"/api/v1/filter_groups/:id","http_method":"PUT","short_description":"Update Filter Set by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/filter_groups/:id","http_method":"DELETE","short_description":"Destroy Filter Set by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"firewall_rules":{"doc_url":"/api/docs/1.0/firewall_rules","id":"firewall_rules","api_url":"/api","name":"Firewall Rule","short_description":"API resource for managing Firewall Rule.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/firewall_rules/index","name":"index","apis":[{"api_url":"/api/v1/firewall_rules","http_method":"GET","short_description":"List Firewall Rule records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ntarget\n</li>\n<li class='column-attempt'>\nvalue\n</li>\n<li class='column-attempt'>\nmode\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nnotes\n</li>\n<li class='column-attempt'>\naccess_rule_id\n</li>\n<li class='column-attempt'>\noccurrences\n</li>\n<li class='column-attempt'>\nexpires_at\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/firewall_rules/show","name":"show","apis":[{"api_url":"/api/v1/firewall_rules/:id","http_method":"GET","short_description":"Get Firewall Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/firewall_rules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/firewall_rules/:id","http_method":"DELETE","short_description":"Destroy Firewall Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"freeswitch_licenses":{"doc_url":"/api/docs/1.0/freeswitch_licenses","id":"freeswitch_licenses","api_url":"/api","name":"Freeswitch License","short_description":"API resource for managing Freeswitch License.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/freeswitch_licenses/index","name":"index","apis":[{"api_url":"/api/v1/freeswitch_licenses","http_method":"GET","short_description":"List Freeswitch License records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nserver_role\n</li>\n<li class='column-attempt'>\nlicense\n</li>\n<li class='column-attempt'>\nlicense_contents\n</li>\n<li class='column-attempt'>\nelastic_ip\n</li>\n<li class='column-attempt'>\ncurrent_server_name\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/freeswitch_licenses/new","name":"new","apis":[{"api_url":"/api/v1/freeswitch_licenses/new","http_method":"GET","short_description":"Build Freeswitch License with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/freeswitch_licenses/create","name":"create","apis":[{"api_url":"/api/v1/freeswitch_licenses","http_method":"POST","short_description":"Create Freeswitch License.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/freeswitch_licenses/show","name":"show","apis":[{"api_url":"/api/v1/freeswitch_licenses/:id","http_method":"GET","short_description":"Get Freeswitch License by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/freeswitch_licenses/update","name":"update","apis":[{"api_url":"/api/v1/freeswitch_licenses/:id","http_method":"PUT","short_description":"Update Freeswitch License by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/freeswitch_licenses/destroy","name":"destroy","apis":[{"api_url":"/api/v1/freeswitch_licenses/:id","http_method":"DELETE","short_description":"Destroy Freeswitch License by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"global_suppression_files":{"doc_url":"/api/docs/1.0/global_suppression_files","id":"global_suppression_files","api_url":"/api","name":"Global Suppression File","short_description":"API resource for managing Global Suppression File.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/global_suppression_files/index","name":"index","apis":[{"api_url":"/api/v1/global_suppression_files","http_method":"GET","short_description":"List Global Suppression File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nnotes\n</li>\n<li class='column-attempt'>\nimport_file_url\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nlist_type\n</li>\n<li class='column-attempt'>\ndata_map_caller_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nerror_message\n</li>\n<li class='column-attempt'>\nimport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\npaused_at\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nstopped_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nheaders\n</li>\n<li class='column-attempt'>\ncurrent_line_number\n</li>\n<li class='column-attempt'>\ndata_map_delta_column\n</li>\n<li class='column-attempt'>\ndelta_add_value\n</li>\n<li class='column-attempt'>\ndelta_remove_value\n</li>\n<li class='column-attempt'>\naction_type\n</li>\n<li class='column-attempt'>\nbusiness_hours_open\n</li>\n<li class='column-attempt'>\nbusiness_hours_close\n</li>\n<li class='column-attempt'>\ntime_zone\n</li>\n<li class='column-attempt'>\ncontacts_removed_count\n</li>\n<li class='column-attempt'>\ncontacts_added_count\n</li>\n<li class='column-attempt'>\ncreated_count\n</li>\n<li class='column-attempt'>\nprocessed_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/global_suppression_files/new","name":"new","apis":[{"api_url":"/api/v1/global_suppression_files/new","http_method":"GET","short_description":"Build Global Suppression File with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/global_suppression_files/create","name":"create","apis":[{"api_url":"/api/v1/global_suppression_files","http_method":"POST","short_description":"Create Global Suppression File.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"import_file","full_name":"import_file","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/global_suppression_files/show","name":"show","apis":[{"api_url":"/api/v1/global_suppression_files/:id","http_method":"GET","short_description":"Get Global Suppression File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/global_suppression_files/update","name":"update","apis":[{"api_url":"/api/v1/global_suppression_files/:id","http_method":"PUT","short_description":"Update Global Suppression File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/global_suppression_files/destroy","name":"destroy","apis":[{"api_url":"/api/v1/global_suppression_files/:id","http_method":"DELETE","short_description":"Destroy Global Suppression File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"impressions":{"doc_url":"/api/docs/1.0/impressions","id":"impressions","api_url":"/api","name":"Impressions","short_description":"The impressions recorded by the advertising optimizer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/impressions/index","name":"index","apis":[{"api_url":"/api/v1/impressions","http_method":"GET","short_description":"Advertising optimizer impressions.","deprecated":null}],"formats":["csv","json"],"full_description":"","errors":[],"params":[{"name":"cursor","full_name":"cursor","description":"\n<p>The API provides a technique called ‘cursoring&#39; to paginate large result sets. Cursoring separates results into pages (the size of which are defined by the per_page request parameter) and provides a means to move backwards and forwards through these pages. To retrieve cursored results, you initially pass a cursor with a value of -1 to the endpoint. By default, an API endpoint that supports cursoring will assume -1 was passed as cursor if you do not provide one. The response to a cursored request will contain <strong>metadata.next_cursor</strong>. The next_cursor is the cursor that you should send to the endpoint to receive the next batch of responses. You will know that you have requested the last available page of results when the API responds with a next_cursor = 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/impressions.csv?&created_at_from=2024-11-14\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"inbound_webhook_logs":{"doc_url":"/api/docs/1.0/inbound_webhook_logs","id":"inbound_webhook_logs","api_url":"/api","name":"Offers: Incoming Webhooks: Logs","short_description":"API resource for managing Ping/Post Logs.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/inbound_webhook_logs/index","name":"index","apis":[{"api_url":"/api/v1/inbound_webhook_logs","http_method":"GET","short_description":"List Ping/Post Logs records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ninbound_webhook_id\n</li>\n<li class='column-attempt'>\nrequest_params\n</li>\n<li class='column-attempt'>\ncreated_int\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nrequest_method\n</li>\n<li class='column-attempt'>\nsource_ip\n</li>\n<li class='column-attempt'>\nresponse_status\n</li>\n<li class='column-attempt'>\nresponse_success\n</li>\n<li class='column-attempt'>\nrequest_duration\n</li>\n<li class='column-attempt'>\ncaller_id\n</li>\n<li class='column-attempt'>\nwebhook_logs_count\n</li>\n<li class='column-attempt'>\nwebhook_log_ids\n</li>\n<li class='column-attempt'>\ncall_uuid\n</li>\n<li class='column-attempt'>\nmessages\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"inbound_webhooks":{"doc_url":"/api/docs/1.0/inbound_webhooks","id":"inbound_webhooks","api_url":"/api","name":"Offers: Incoming Webhooks","short_description":"API resource for managing Incoming Webhook.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/inbound_webhooks/ping","name":"ping","apis":[{"api_url":"/api/v1/inbound_webhooks/ping/:vanity_uri","http_method":"POST","short_description":"PING an inbound webhook to retrieve available agents or buyers.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\n<p>The unique identifier for this endpoint.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_token","full_name":"auth_token","description":"\n<p>Authorize requests using your token. Get it from your profile: <a href=\"https://trackdrive.com/profile/edit\">trackdrive.com/profile/edit</a></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/post","name":"post","apis":[{"api_url":"/api/v1/inbound_webhooks/post/:vanity_uri","http_method":"POST","short_description":"POST with a ping_id to retrieve a tracking number for forwarding an inbound call to a matching buyer.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\n<p>The unique identifier for this endpoint.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ping_id","full_name":"ping_id","description":"\n<p>Ping ID</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/index","name":"index","apis":[{"api_url":"/api/v1/inbound_webhooks","http_method":"GET","short_description":"List Incoming Webhook records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ntemplate_description\n</li>\n<li class='column-attempt'>\ntemplate_enabled\n</li>\n<li class='column-attempt'>\ntemplate_tier\n</li>\n<li class='column-attempt'>\nrequire_caller_id_on_ping\n</li>\n<li class='column-attempt'>\nvanity_uri\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nwebhook_type\n</li>\n<li class='column-attempt'>\ncall_router_ids\n</li>\n<li class='column-attempt'>\nbuyer_ids\n</li>\n<li class='column-attempt'>\nbuyer_group_ids\n</li>\n<li class='column-attempt'>\nresponse_body\n</li>\n<li class='column-attempt'>\nrequire_traffic_source_id\n</li>\n<li class='column-attempt'>\nrequire_user_auth_token\n</li>\n<li class='column-attempt'>\ncompany_subdomain\n</li>\n<li class='column-attempt'>\ntracking_type\n</li>\n<li class='column-attempt'>\nring_pool_id\n</li>\n<li class='column-attempt'>\ninclude_dynamic_buyers\n</li>\n<li class='column-attempt'>\nbuyer_ping_column_names\n</li>\n<li class='column-attempt'>\nbuyer_post_column_names\n</li>\n<li class='column-attempt'>\nenable_public_show\n</li>\n<li class='column-attempt'>\nenable_public_index\n</li>\n<li class='column-attempt'>\npublic_name\n</li>\n<li class='column-attempt'>\npublic_description\n</li>\n<li class='column-attempt'>\ntest_mode\n</li>\n<li class='column-attempt'>\nbuyers_limit_value\n</li>\n<li class='column-attempt'>\nwebhook_read_timeout\n</li>\n<li class='column-attempt'>\nconcurrency_cap_buffer_percent\n</li>\n<li class='column-attempt'>\ndata_append_enabled\n</li>\n<li class='column-attempt'>\ndata_append_group_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/new","name":"new","apis":[{"api_url":"/api/v1/inbound_webhooks/new","http_method":"GET","short_description":"Build Incoming Webhook with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\n<p>The unique identifier for this endpoint.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\n<p>Webhook Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>check_for_available_instant_agent</code>, <code>check_for_available_buyer</code>, <code>fire_webhooks</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_ids","full_name":"call_router_ids","description":"\n<p>Call Router Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>Buyer Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Buyer Group Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"response_body","full_name":"response_body","description":"\n<p>Response Body</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/create","name":"create","apis":[{"api_url":"/api/v1/inbound_webhooks","http_method":"POST","short_description":"Create Incoming Webhook.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\n<p>The unique identifier for this endpoint.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\n<p>Webhook Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>check_for_available_instant_agent</code>, <code>check_for_available_buyer</code>, <code>fire_webhooks</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_ids","full_name":"call_router_ids","description":"\n<p>Call Router Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>Buyer Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Buyer Group Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"response_body","full_name":"response_body","description":"\n<p>Response Body</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/show","name":"show","apis":[{"api_url":"/api/v1/inbound_webhooks/:id","http_method":"GET","short_description":"Get Incoming Webhook by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/update","name":"update","apis":[{"api_url":"/api/v1/inbound_webhooks/:id","http_method":"PUT","short_description":"Update Incoming Webhook by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\n<p>The unique identifier for this endpoint.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\n<p>Webhook Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>check_for_available_instant_agent</code>, <code>check_for_available_buyer</code>, <code>fire_webhooks</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_ids","full_name":"call_router_ids","description":"\n<p>Call Router Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n<p>Buyer Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n<p>Buyer Group Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"response_body","full_name":"response_body","description":"\n<p>Response Body</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/inbound_webhooks/:id","http_method":"DELETE","short_description":"Destroy Incoming Webhook by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"incoming_text_messages":{"doc_url":"/api/docs/1.0/incoming_text_messages","id":"incoming_text_messages","api_url":"/api","name":"SMS: Incoming Text Messages","short_description":"API resource for managing Incoming Text Message.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/incoming_text_messages/index","name":"index","apis":[{"api_url":"/api/v1/incoming_text_messages","http_method":"GET","short_description":"List Incoming Text Message records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nfrom\n</li>\n<li class='column-attempt'>\nto\n</li>\n<li class='column-attempt'>\nmessage\n</li>\n<li class='column-attempt'>\nopted_out\n</li>\n<li class='column-attempt'>\nnumber_id\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\nprovider_configuration_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\ncontact_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/incoming_text_messages/show","name":"show","apis":[{"api_url":"/api/v1/incoming_text_messages/:id","http_method":"GET","short_description":"Get Incoming Text Message by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"integrations":{"doc_url":"/api/docs/1.0/integrations","id":"integrations","api_url":"/api","name":"Integration","short_description":"API resource for managing Integrations.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/integrations/index","name":"index","apis":[{"api_url":"/api/v1/integrations","http_method":"GET","short_description":"List Integration records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nintegration_type\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\npublic_key\n</li>\n<li class='column-attempt'>\ncategory\n</li>\n<li class='column-attempt'>\nconnected_status\n</li>\n<li class='column-attempt'>\nconnected_at\n</li>\n<li class='column-attempt'>\ndisconnected_at\n</li>\n<li class='column-attempt'>\nis_oauth2\n</li>\n<li class='column-attempt'>\nzoho_update_td_login_token\n</li>\n<li class='column-attempt'>\ncache_expires_in\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/update_object","name":"update_object","apis":[{"api_url":"/api/v1/integrations/objects/:id","http_method":"PUT","short_description":"Update the status of an Integration Object.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"active","full_name":"active","description":"\n<p>Enable or disable an integration object.</p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/new","name":"new","apis":[{"api_url":"/api/v1/integrations/new","http_method":"GET","short_description":"Build Integration with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"integration_type","full_name":"integration_type","description":"\n<p>Integration Type</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>google_adwords</code>, <code>typeform</code>, <code>mailchimp</code>, <code>pagerduty</code>, <code>zoho_crm</code>, <code>tcpa_shield</code>, <code>mailgun</code>, <code>salesforce</code>, <code>slack</code>, <code>facebook_leadads</code>, <code>blacklist_alliance</code>, <code>sendgrid</code>, <code>zadarma</code>, <code>infusionsoft</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/create","name":"create","apis":[{"api_url":"/api/v1/integrations","http_method":"POST","short_description":"Create Integration.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"integration_type","full_name":"integration_type","description":"\n<p>Integration Type</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>google_adwords</code>, <code>typeform</code>, <code>mailchimp</code>, <code>pagerduty</code>, <code>zoho_crm</code>, <code>tcpa_shield</code>, <code>mailgun</code>, <code>salesforce</code>, <code>slack</code>, <code>facebook_leadads</code>, <code>blacklist_alliance</code>, <code>sendgrid</code>, <code>zadarma</code>, <code>infusionsoft</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/show","name":"show","apis":[{"api_url":"/api/v1/integrations/:id","http_method":"GET","short_description":"Get Integration by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/update","name":"update","apis":[{"api_url":"/api/v1/integrations/:id","http_method":"PUT","short_description":"Update Integration by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"integration_type","full_name":"integration_type","description":"\n<p>Integration Type</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>google_adwords</code>, <code>typeform</code>, <code>mailchimp</code>, <code>pagerduty</code>, <code>zoho_crm</code>, <code>tcpa_shield</code>, <code>mailgun</code>, <code>salesforce</code>, <code>slack</code>, <code>facebook_leadads</code>, <code>blacklist_alliance</code>, <code>sendgrid</code>, <code>zadarma</code>, <code>infusionsoft</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/integrations/:id","http_method":"DELETE","short_description":"Destroy Integration by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"key_press_flow_groups":{"doc_url":"/api/docs/1.0/key_press_flow_groups","id":"key_press_flow_groups","api_url":"/api","name":"Offers: Key Press Flow Group","short_description":"API resource for managing Key Press Flow Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/key_press_flow_groups/index","name":"index","apis":[{"api_url":"/api/v1/key_press_flow_groups","http_method":"GET","short_description":"List Key Press Flow Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flow_groups/new","name":"new","apis":[{"api_url":"/api/v1/key_press_flow_groups/new","http_method":"GET","short_description":"Build Key Press Flow Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flow_groups/create","name":"create","apis":[{"api_url":"/api/v1/key_press_flow_groups","http_method":"POST","short_description":"Create Key Press Flow Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flow_groups/show","name":"show","apis":[{"api_url":"/api/v1/key_press_flow_groups/:id","http_method":"GET","short_description":"Get Key Press Flow Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flow_groups/update","name":"update","apis":[{"api_url":"/api/v1/key_press_flow_groups/:id","http_method":"PUT","short_description":"Update Key Press Flow Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flow_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/key_press_flow_groups/:id","http_method":"DELETE","short_description":"Destroy Key Press Flow Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"key_press_flows":{"doc_url":"/api/docs/1.0/key_press_flows","id":"key_press_flows","api_url":"/api","name":"Offers: Key Press Flow","short_description":"API resource for managing Key Press Flow.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/key_press_flows/index","name":"index","apis":[{"api_url":"/api/v1/key_press_flows","http_method":"GET","short_description":"List Key Press Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nkey_press_flow_group_id\n</li>\n<li class='column-attempt'>\nkey_press\n</li>\n<li class='column-attempt'>\ncall_control_action_ids\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nwebhook_actions_count\n</li>\n<li class='column-attempt'>\ncall_disposition_id\n</li>\n<li class='column-attempt'>\ncontinue_call_routing\n</li>\n<li class='column-attempt'>\nbuyer_conference_time_elapsed_seconds_limit\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flows/new","name":"new","apis":[{"api_url":"/api/v1/key_press_flows/new","http_method":"GET","short_description":"Build Key Press Flow with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n<p>Key Press Flow Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_press","full_name":"key_press","description":"\n<p>Key Press</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flows/create","name":"create","apis":[{"api_url":"/api/v1/key_press_flows","http_method":"POST","short_description":"Create Key Press Flow.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n<p>Key Press Flow Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_press","full_name":"key_press","description":"\n<p>Key Press</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flows/show","name":"show","apis":[{"api_url":"/api/v1/key_press_flows/:id","http_method":"GET","short_description":"Get Key Press Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flows/update","name":"update","apis":[{"api_url":"/api/v1/key_press_flows/:id","http_method":"PUT","short_description":"Update Key Press Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n<p>Key Press Flow Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_press","full_name":"key_press","description":"\n<p>Key Press</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/key_press_flows/:id","http_method":"DELETE","short_description":"Destroy Key Press Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_alterations":{"doc_url":"/api/docs/1.0/lead_alterations","id":"lead_alterations","api_url":"/api","name":"Schedules: Lead Modifications","short_description":"The configuration for how leads are modified on an lead modification schedule action.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_alterations/index","name":"index","apis":[{"api_url":"/api/v1/lead_alterations","http_method":"GET","short_description":"List lead modifications.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Translation missing: en.api.lead_alterations.schedule_action_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/new","name":"new","apis":[{"api_url":"/api/v1/lead_alterations/new","http_method":"GET","short_description":"Build a lead modification with default attributes.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/create","name":"create","apis":[{"api_url":"/api/v1/lead_alterations","http_method":"POST","short_description":"Create a lead modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Translation missing: en.api.lead_alterations.schedule_action_id</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Translation missing: en.api.lead_alterations.key</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operator","full_name":"operator","description":"\n<p>Translation missing: en.api.lead_alterations.operator</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>set</code>, <code>add_decimal</code>, <code>subtract_decimal</code>, <code>add_string</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Translation missing: en.api.lead_alterations.value</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/show","name":"show","apis":[{"api_url":"/api/v1/lead_alterations/:id","http_method":"GET","short_description":"Get details about a lead modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/update","name":"update","apis":[{"api_url":"/api/v1/lead_alterations/:id","http_method":"PUT","short_description":"Update a lead modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Translation missing: en.api.lead_alterations.schedule_action_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Translation missing: en.api.lead_alterations.key</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operator","full_name":"operator","description":"\n<p>Translation missing: en.api.lead_alterations.operator</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>set</code>, <code>add_decimal</code>, <code>subtract_decimal</code>, <code>add_string</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Translation missing: en.api.lead_alterations.value</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_alterations/:id","http_method":"DELETE","short_description":"Destroy a lead modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_imports":{"doc_url":"/api/docs/1.0/lead_imports","id":"lead_imports","api_url":"/api","name":"Lead Import","short_description":"API resource for managing Lead Import.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_imports/index","name":"index","apis":[{"api_url":"/api/v1/lead_imports","http_method":"GET","short_description":"List Lead Import records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\ndata_maps_set\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndata_json\n</li>\n<li class='column-attempt'>\nerror_message\n</li>\n<li class='column-attempt'>\nimport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\npaused_at\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nstopped_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nrecent_calls_count\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nlead_priority\n</li>\n<li class='column-attempt'>\nupdate_only\n</li>\n<li class='column-attempt'>\nsub_id\n</li>\n<li class='column-attempt'>\noff_hook_buyer_id\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\npause_leads\n</li>\n<li class='column-attempt'>\nchange_next_action_at\n</li>\n<li class='column-attempt'>\nset_next_action_at\n</li>\n<li class='column-attempt'>\nset_next_action_time_zone\n</li>\n<li class='column-attempt'>\napply_data_to_calls\n</li>\n<li class='column-attempt'>\nmanage_move_to_another_schedule\n</li>\n<li class='column-attempt'>\nmanage_move_to_another_schedule_id\n</li>\n<li class='column-attempt'>\nmanage_add_to_schedule\n</li>\n<li class='column-attempt'>\nmanage_add_to_schedule_id\n</li>\n<li class='column-attempt'>\nmanage_delete_lead\n</li>\n<li class='column-attempt'>\ncreated_count\n</li>\n<li class='column-attempt'>\nmanage_schedule_action\n</li>\n<li class='column-attempt'>\nmanage_opt_out_and_in\n</li>\n<li class='column-attempt'>\nmanage_block_and_unblock\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_imports/new","name":"new","apis":[{"api_url":"/api/v1/lead_imports/new","http_method":"GET","short_description":"Build Lead Import with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_imports/create","name":"create","apis":[{"api_url":"/api/v1/lead_imports","http_method":"POST","short_description":"Create Lead Import.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_imports/show","name":"show","apis":[{"api_url":"/api/v1/lead_imports/:id","http_method":"GET","short_description":"Get Lead Import by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_imports/update","name":"update","apis":[{"api_url":"/api/v1/lead_imports/:id","http_method":"PUT","short_description":"Update Lead Import by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_imports/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_imports/:id","http_method":"DELETE","short_description":"Destroy Lead Import by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_migrators":{"doc_url":"/api/docs/1.0/lead_migrators","id":"lead_migrators","api_url":"/api","name":"Lead Migrator","short_description":"API resource for managing Lead Migrator.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_migrators/index","name":"index","apis":[{"api_url":"/api/v1/lead_migrators","http_method":"GET","short_description":"List Lead Migrator records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsource_company_id\n</li>\n<li class='column-attempt'>\ntarget_company_id\n</li>\n<li class='column-attempt'>\nactive\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\ncounter\n</li>\n<li class='column-attempt'>\nlast_id\n</li>\n<li class='column-attempt'>\nskip_sms_opt_out\n</li>\n<li class='column-attempt'>\nskip_dnc_global\n</li>\n<li class='column-attempt'>\ntarget_offer_id\n</li>\n<li class='column-attempt'>\ntarget_traffic_source_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/new","name":"new","apis":[{"api_url":"/api/v1/lead_migrators/new","http_method":"GET","short_description":"Build Lead Migrator with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n<p>User</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"source_company_id","full_name":"source_company_id","description":"\n<p>Source Company</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_company_id","full_name":"target_company_id","description":"\n<p>Target Company</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active","full_name":"active","description":"\n<p>Active</p>\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":[]},{"name":"counter","full_name":"counter","description":"\n<p>Counter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_id","full_name":"last_id","description":"\n<p>Last</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/create","name":"create","apis":[{"api_url":"/api/v1/lead_migrators","http_method":"POST","short_description":"Create Lead Migrator.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n<p>User</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"source_company_id","full_name":"source_company_id","description":"\n<p>Source Company</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_company_id","full_name":"target_company_id","description":"\n<p>Target Company</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active","full_name":"active","description":"\n<p>Active</p>\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":[]},{"name":"counter","full_name":"counter","description":"\n<p>Counter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_id","full_name":"last_id","description":"\n<p>Last</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/show","name":"show","apis":[{"api_url":"/api/v1/lead_migrators/:id","http_method":"GET","short_description":"Get Lead Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/update","name":"update","apis":[{"api_url":"/api/v1/lead_migrators/:id","http_method":"PUT","short_description":"Update Lead Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n<p>User</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"source_company_id","full_name":"source_company_id","description":"\n<p>Source Company</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_company_id","full_name":"target_company_id","description":"\n<p>Target Company</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active","full_name":"active","description":"\n<p>Active</p>\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":[]},{"name":"counter","full_name":"counter","description":"\n<p>Counter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_id","full_name":"last_id","description":"\n<p>Last</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_migrators/:id","http_method":"DELETE","short_description":"Destroy Lead Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_retarget_logs":{"doc_url":"/api/docs/1.0/lead_retarget_logs","id":"lead_retarget_logs","api_url":"/api","name":"Leads: Retargeting: Logs","short_description":"API resource for accessing Lead Retarget Logs.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_retarget_logs/index","name":"index","apis":[{"api_url":"/api/v1/lead_retarget_logs","http_method":"GET","short_description":"List Lead Retarget Log records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nlead_retarget_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\noriginal_lead_id\n</li>\n<li class='column-attempt'>\nmessage\n</li>\n<li class='column-attempt'>\nsuccess\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_retargets":{"doc_url":"/api/docs/1.0/lead_retargets","id":"lead_retargets","api_url":"/api","name":"Leads: Retargeting","short_description":"API resource for managing Lead Retargeting.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_retargets/index","name":"index","apis":[{"api_url":"/api/v1/lead_retargets","http_method":"GET","short_description":"List Lead Retargeting records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nlead_import_id\n</li>\n<li class='column-attempt'>\nscrub_buyer_connected\n</li>\n<li class='column-attempt'>\ndata_source_type\n</li>\n<li class='column-attempt'>\nfilter_owner_type\n</li>\n<li class='column-attempt'>\nadd_to_schedule_enabled\n</li>\n<li class='column-attempt'>\nadd_to_schedule_id\n</li>\n<li class='column-attempt'>\nscrub_buyer_attempted\n</li>\n<li class='column-attempt'>\nscrub_buyer_converted\n</li>\n<li class='column-attempt'>\nscrub_call_disposition_ids\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\nretarget_count\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\njobs_generated_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nform_step_actions_complete\n</li>\n<li class='column-attempt'>\nform_steps\n</li>\n<li class='column-attempt'>\nprogress_percent\n</li>\n<li class='column-attempt'>\nscrub_is_live\n</li>\n<li class='column-attempt'>\nsuccess_count\n</li>\n<li class='column-attempt'>\nfilter_traffic_source_id\n</li>\n<li class='column-attempt'>\nfilter_dial_tier_greater_than\n</li>\n<li class='column-attempt'>\nfilter_dial_tier_less_than\n</li>\n<li class='column-attempt'>\nscrub_opt_out\n</li>\n<li class='column-attempt'>\nfilter_schedule_trigger_type\n</li>\n<li class='column-attempt'>\ndata_source_schedule_id\n</li>\n<li class='column-attempt'>\nfilter_created_at_from\n</li>\n<li class='column-attempt'>\nfilter_created_at_to\n</li>\n<li class='column-attempt'>\nscrub_buyer_attempted_from\n</li>\n<li class='column-attempt'>\nscrub_buyer_attempted_to\n</li>\n<li class='column-attempt'>\nscrub_buyer_connected_from\n</li>\n<li class='column-attempt'>\nscrub_buyer_connected_to\n</li>\n<li class='column-attempt'>\nscrub_buyer_converted_from\n</li>\n<li class='column-attempt'>\nscrub_buyer_converted_to\n</li>\n<li class='column-attempt'>\nscrub_call_disposition_ids_from\n</li>\n<li class='column-attempt'>\nscrub_call_disposition_ids_to\n</li>\n<li class='column-attempt'>\nschedule_action_ids\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/new","name":"new","apis":[{"api_url":"/api/v1/lead_retargets/new","http_method":"GET","short_description":"Build Lead Retargeting with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_import_id","full_name":"lead_import_id","description":"\n<p>Lead Import</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead Import}[/api/docs/1.0/lead_imports/index.html]. Refer to: {/api/docs/1.0/lead_imports}[/api/docs/1.0/lead_imports/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/create","name":"create","apis":[{"api_url":"/api/v1/lead_retargets","http_method":"POST","short_description":"Create Lead Retargeting.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_import_id","full_name":"lead_import_id","description":"\n<p>Lead Import</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead Import}[/api/docs/1.0/lead_imports/index.html]. Refer to: {/api/docs/1.0/lead_imports}[/api/docs/1.0/lead_imports/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/show","name":"show","apis":[{"api_url":"/api/v1/lead_retargets/:id","http_method":"GET","short_description":"Get Lead Retargeting by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/update","name":"update","apis":[{"api_url":"/api/v1/lead_retargets/:id","http_method":"PUT","short_description":"Update Lead Retargeting by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_import_id","full_name":"lead_import_id","description":"\n<p>Lead Import</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead Import}[/api/docs/1.0/lead_imports/index.html]. Refer to: {/api/docs/1.0/lead_imports}[/api/docs/1.0/lead_imports/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_retargets/:id","http_method":"DELETE","short_description":"Destroy Lead Retargeting by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_wait_rule_groups":{"doc_url":"/api/docs/1.0/lead_wait_rule_groups","id":"lead_wait_rule_groups","api_url":"/api","name":"Wait Rule Group","short_description":"API resource for managing Wait Rule Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_wait_rule_groups/index","name":"index","apis":[{"api_url":"/api/v1/lead_wait_rule_groups","http_method":"GET","short_description":"List Wait Rule Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nlead_wait_rules_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rule_groups/new","name":"new","apis":[{"api_url":"/api/v1/lead_wait_rule_groups/new","http_method":"GET","short_description":"Build Wait Rule Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_wait_rule_ids","full_name":"lead_wait_rule_ids","description":"\n<p>Lead Wait Rule Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rule_groups/create","name":"create","apis":[{"api_url":"/api/v1/lead_wait_rule_groups","http_method":"POST","short_description":"Create Wait Rule Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_wait_rule_ids","full_name":"lead_wait_rule_ids","description":"\n<p>Lead Wait Rule Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rule_groups/show","name":"show","apis":[{"api_url":"/api/v1/lead_wait_rule_groups/:id","http_method":"GET","short_description":"Get Wait Rule Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rule_groups/update","name":"update","apis":[{"api_url":"/api/v1/lead_wait_rule_groups/:id","http_method":"PUT","short_description":"Update Wait Rule Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_wait_rule_ids","full_name":"lead_wait_rule_ids","description":"\n<p>Lead Wait Rule Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rule_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_wait_rule_groups/:id","http_method":"DELETE","short_description":"Destroy Wait Rule Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_wait_rules":{"doc_url":"/api/docs/1.0/lead_wait_rules","id":"lead_wait_rules","api_url":"/api","name":"Wait Rule","short_description":"API resource for managing Wait Rule.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_wait_rules/index","name":"index","apis":[{"api_url":"/api/v1/lead_wait_rules","http_method":"GET","short_description":"List Wait Rule records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nwait_seconds\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nfilter_call_disposition_ids\n</li>\n<li class='column-attempt'>\nfilter_call_disposition_two_ids\n</li>\n<li class='column-attempt'>\nrecord_token_filter_two_id\n</li>\n<li class='column-attempt'>\ntier\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_filter_two_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_two_data\n</li>\n<li class='column-attempt'>\nlead_wait_rule_group_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/new","name":"new","apis":[{"api_url":"/api/v1/lead_wait_rules/new","http_method":"GET","short_description":"Build Wait Rule with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wait_seconds","full_name":"wait_seconds","description":"\n<p>Wait Seconds</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_call_disposition_ids","full_name":"filter_call_disposition_ids","description":"\n<p>Call Dispositions</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_call_disposition_two_ids","full_name":"filter_call_disposition_two_ids","description":"\n<p>Call Dispositions Two Calls Ago</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_two_id","full_name":"record_token_filter_two_id","description":"\n<p>Record Token Filter Two</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_two_ids","full_name":"token_value_two_ids","description":"\n<p>Token Value Two Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/create","name":"create","apis":[{"api_url":"/api/v1/lead_wait_rules","http_method":"POST","short_description":"Create Wait Rule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wait_seconds","full_name":"wait_seconds","description":"\n<p>Wait Seconds</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_call_disposition_ids","full_name":"filter_call_disposition_ids","description":"\n<p>Call Dispositions</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_call_disposition_two_ids","full_name":"filter_call_disposition_two_ids","description":"\n<p>Call Dispositions Two Calls Ago</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_two_id","full_name":"record_token_filter_two_id","description":"\n<p>Record Token Filter Two</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_two_ids","full_name":"token_value_two_ids","description":"\n<p>Token Value Two Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/show","name":"show","apis":[{"api_url":"/api/v1/lead_wait_rules/:id","http_method":"GET","short_description":"Get Wait Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/update","name":"update","apis":[{"api_url":"/api/v1/lead_wait_rules/:id","http_method":"PUT","short_description":"Update Wait Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wait_seconds","full_name":"wait_seconds","description":"\n<p>Wait Seconds</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_call_disposition_ids","full_name":"filter_call_disposition_ids","description":"\n<p>Call Dispositions</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_call_disposition_two_ids","full_name":"filter_call_disposition_two_ids","description":"\n<p>Call Dispositions Two Calls Ago</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Disposition}[/api/docs/1.0/call_dispositions/index.html]. Refer to: {/api/docs/1.0/call_dispositions}[/api/docs/1.0/call_dispositions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_two_id","full_name":"record_token_filter_two_id","description":"\n<p>Record Token Filter Two</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_two_ids","full_name":"token_value_two_ids","description":"\n<p>Token Value Two Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_wait_rules/:id","http_method":"DELETE","short_description":"Destroy Wait Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"leads_agent_dial_actions":{"doc_url":"/api/docs/1.0/leads_agent_dial_actions","id":"leads_agent_dial_actions","api_url":"/api","name":"Leads: Matching Leads Dial Queue","short_description":"List leads that are waiting for a call and match an Instant Agent Call Flow and at least one Buyer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/leads_agent_dial_actions/index","name":"index","apis":[{"api_url":"/api/v1/leads_agent_dial_actions","http_method":"GET","short_description":"List Matching Leads records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nnext_action_at\n</li>\n<li class='column-attempt'>\ndial_tier\n</li>\n<li class='column-attempt'>\nutc_offset\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nlead_import_id\n</li>\n<li class='column-attempt'>\ntrackdrive_agent_id\n</li>\n<li class='column-attempt'>\nschedule_trigger_type\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\ncall_center_id\n</li>\n<li class='column-attempt'>\nhas_next_action\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_agent_dial_actions/show","name":"show","apis":[{"api_url":"/api/v1/leads_agent_dial_actions/:id","http_method":"GET","short_description":"Get Matching Leads by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"leads":{"doc_url":"/api/docs/1.0/leads","id":"leads","api_url":"/api","name":"Leads","short_description":"Manage the leads in your Trackdrive account via API.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/leads/index","name":"index","apis":[{"api_url":"/api/v1/leads","http_method":"GET","short_description":"List your leads.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>lead</th><td>Lead</td></tr><tr><th>lead_grid</th><td>Lead Grid</td></tr><tr><th>lead_external</th><td>Lead External</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncaller_id\n</li>\n<li class='column-attempt'>\nemail\n</li>\n<li class='column-attempt'>\nfull_name\n</li>\n<li class='column-attempt'>\ncontact_field_type\n</li>\n<li class='column-attempt'>\nexpires_in\n</li>\n<li class='column-attempt'>\ncountry\n</li>\n<li class='column-attempt'>\nstate_province\n</li>\n<li class='column-attempt'>\nzip_postal_code\n</li>\n<li class='column-attempt'>\ntime_zone\n</li>\n<li class='column-attempt'>\nsub_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nhuman_status\n</li>\n<li class='column-attempt'>\ncss_status\n</li>\n<li class='column-attempt'>\nhas_next_action\n</li>\n<li class='column-attempt'>\nopt_out\n</li>\n<li class='column-attempt'>\nrevenue\n</li>\n<li class='column-attempt'>\npayout\n</li>\n<li class='column-attempt'>\noffer_converted\n</li>\n<li class='column-attempt'>\nbuyer_converted\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\nlead_import_id\n</li>\n<li class='column-attempt'>\nremote_ip\n</li>\n<li class='column-attempt'>\nattempted_call_id\n</li>\n<li class='column-attempt'>\nconnected_call_id\n</li>\n<li class='column-attempt'>\nscheduled_callback_id\n</li>\n<li class='column-attempt'>\ncall_buyer_conversion_id\n</li>\n<li class='column-attempt'>\ncall_offer_conversion_id\n</li>\n<li class='column-attempt'>\nsms_number_id\n</li>\n<li class='column-attempt'>\ndial_number_id\n</li>\n<li class='column-attempt'>\ndial_tier\n</li>\n<li class='column-attempt'>\nlast_action_at\n</li>\n<li class='column-attempt'>\nfirst_action_at\n</li>\n<li class='column-attempt'>\nfirst_queued_at\n</li>\n<li class='column-attempt'>\nschedule_ended_at\n</li>\n<li class='column-attempt'>\nnext_action_at\n</li>\n<li class='column-attempt'>\nlast_call_at\n</li>\n<li class='column-attempt'>\nis_live\n</li>\n<li class='column-attempt'>\nschedule_trigger_type\n</li>\n<li class='column-attempt'>\nblocked\n</li>\n<li class='column-attempt'>\ndata\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]},{"name":"created_at_label","full_name":"created_at_label","description":"\n<p>Dynamic Date String such as “Today” or “This Year”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>Last 5 Min</code>, <code>Last 15 Min</code>, <code>Last 30 Min</code>, <code>Last Hour</code>, <code>Last 4 Hours</code>, <code>Last 6 Hours</code>, <code>Last 12 Hours</code>, <code>Last Day</code>, <code>Last 2 Days</code>, <code>Today</code>, <code>Yesterday</code>, <code>This Week</code>, <code>Last Week</code>, <code>This Month</code>, <code>Last Month</code>, <code>This Quarter</code>, <code>Last Quarter</code>, <code>Last 6 Months</code>, <code>This Year</code>, <code>Last Year</code>, <code>Lifetime</code>, <code>Custom Range</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"next_action_at_to","full_name":"next_action_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"next_action_at_from","full_name":"next_action_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule internal id.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"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":[]},{"name":"contact_id","full_name":"contact_id","description":"\n<p>Match calls that were placed by this caller.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Contact}[/api/docs/1.0/contacts/index.html]. Refer to: {/api/docs/1.0/contacts}[/api/docs/1.0/contacts/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Refer to the buyer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Match results that have this status.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status_wait","full_name":"status_wait","description":"\n<p>Filter for leads that are waiting before performing an action.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number","full_name":"number","description":"\n<p>Filter for leads matching this callerid.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n<p>The email address for the lead. The lead&#39;s email is required for sending emails from schedules to leads.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"has_next_action","full_name":"has_next_action","description":"\n<p>Filter for leads that have more actions to perform.</p>\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":[]},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n<p>Select leads that have converted.</p>\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":[]},{"name":"offer_converted","full_name":"offer_converted","description":"\n<p>Select leads where a traffic source converted.</p>\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":[]},{"name":"either_converted","full_name":"either_converted","description":"\n<p>Select leads where either a buyer or traffic source converted.</p>\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":[]},{"name":"opt_out","full_name":"opt_out","description":"\n<p>Select leads that have opted-out.</p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/show","name":"show","apis":[{"api_url":"/api/v1/leads/:id","http_method":"GET","short_description":"Get details about a lead.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/buyer_is_available","name":"buyer_is_available","apis":[{"api_url":"/api/v1/leads/:id/buyer_is_available","http_method":"GET","short_description":"Check if a lead has a potential buyer available that matches the lead's filters.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/show_by_caller_number","name":"show_by_caller_number","apis":[{"api_url":"/api/v1/leads/:lead_token/:caller_number/by_caller_number","http_method":"GET","short_description":"Get a lead by lead token and caller number.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n<p>The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_number","full_name":"caller_number","description":"\n<p>Find the lead by this caller number.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/update","name":"update","apis":[{"api_url":"/api/v1/leads/:id","http_method":"PUT","short_description":"Update a lead by uuid.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"contact_field_type","full_name":"contact_field_type","description":"\n<p>Pass an ID belonging to an <code>Agent Script &amp; Field Type</code> to select that <code>Custom Contact Field Type</code> for this call.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id","full_name":"caller_id","description":"\n<p>The callerID for the lead. This is the number Trackdrive will dial when making outbound calls to the lead. This is also the number where Trackdrive will send SMS.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"blocked","full_name":"blocked","description":"\n<p>Set this to true in order to prevent this lead from calling any of your telephone numbers. This will also prevent all outbound actions from Trackdrive.</p>\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":[]},{"name":"opt_out","full_name":"opt_out","description":"\n<p>Select leads that have opted-out.</p>\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":[]},{"name":"email","full_name":"email","description":"\n<p>The email address for the lead. The lead&#39;s email is required for sending emails from schedules to leads.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Update the traffic source associated with this lead.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"next_action_at","full_name":"next_action_at","description":"\n<p>Change when the next action is scheduled to run. EG If you mistakenly scheduled leads to wait until next week, you can use this to bulk update them to run 1 second from now.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_callback_at","full_name":"schedule_callback_at","description":"\n<p>Schedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\n<p>Schedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_start","full_name":"schedule_start","description":"\n<p>Translation missing: en.api.leads.schedule_start</p>\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":[]},{"name":"schedule_stop","full_name":"schedule_stop","description":"\n<p>Removes the lead from the Schedule. No further actions will be taken.</p>\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":[]},{"name":"move_to_another_schedule_id","full_name":"move_to_another_schedule_id","description":"\n<p>Move To Another Schedule - Assign matching leads to the selected schedule. Lead&#39;s already on the selected schedule will restart their schedule.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"apply_to","full_name":"apply_to","description":"\n<p>Should the data you&#39;re sending also be applied to calls associated with this lead?</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>calls</code>, <code>self</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data","full_name":"data","description":"\n<p>Trackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. <code>{interest: &#39;kittens&#39;, source: &#39;google&#39;, first_name: &#39;John&#39;, last_name: &#39;Smith&#39;}</code> Emails and SMS also have access to these tokens, so it&#39;s possible to send email and SMS messages that substitute tokens with values, such as {{first_name}}. Example SMS: “Hello {{first_name}} {{last_name}}, thanks for you inquiry. We will be calling you in 30 seconds from {{trackdrive_number}}”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X PUT \"https://trackdrive.com/api/v1/leads/e36e2da0-6984-4c59-999a-9207c973e143?opt_out=true\"\n\n# Update leads with application/json:\ncurl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"opt_out\":true}' \"https://trackdrive.com/api/v1/leads/e36e2da0-6984-4c59-999a-9207c973e143\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/new","name":"new","apis":[{"api_url":"/api/v1/leads/new","http_method":"GET","short_description":"Build a new lead with company defaults.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/destroy_by_id","name":"destroy_by_id","apis":[{"api_url":"/api/v1/leads/:id/id","http_method":"DELETE","short_description":"Destory a lead by it's internal id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/reports","name":"reports","apis":[{"api_url":"/api/v1/leads/reports","http_method":"GET","short_description":"Get statistics on leads by category.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"category","full_name":"category","description":"\n<p>Translation missing: en.api.leads.category</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>status</th><td>Status</td></tr><tr><th>offer_id</th><td>Offer</td></tr><tr><th>schedule_id</th><td>Schedule</td></tr><tr><th>schedule_action_id</th><td>Schedule Action</td></tr><tr><th>buyer_converted_schedule_action_id</th><td>The schedule action where the lead converted.</td></tr><tr><th>lead_import_id</th><td>Lead Import</td></tr><tr><th>traffic_source_id</th><td>Traffic Source</td></tr><tr><th>outbound_calls_count</th><td>Outbound Calls Count</td></tr><tr><th>inbound_calls_count</th><td>Inbound Calls Count</td></tr><tr><th>recent_call_disposition_id</th><td>Recent Call Disposition</td></tr><tr><th>buyer_converted_days</th><td>Buyer Converted Days</td></tr><tr><th>buyer_id</th><td>Buyer</td></tr><tr><th>country</th><td>Country</td></tr><tr><th>call_center_id</th><td>Call Center</td></tr><tr><th>state</th><td>State</td></tr><tr><th>sub_id</th><td>Sub ID</td></tr><tr><th>dial_tier</th><td>Dial Tier</td></tr><tr><th>contact_field_type</th><td>Contact Field Type</td></tr><tr><th>created_at_day</th><td>The day the lead was submitted</td></tr><tr><th>created_at_month</th><td>The month the lead was submitted</td></tr><tr><th>created_at_week</th><td>The week the lead was submitted</td></tr><tr><th>created_at_five_minutes</th><td>The minute the lead was submitted</td></tr><tr><th>created_at_hour</th><td>The hour lead was submitted</td></tr><tr><th>schedule_trigger_type</th><td>Schedule Trigger Type</td></tr><tr><th>zip_postal_code</th><td>Zip/Postal Code</td></tr><tr><th>country</th><td>Country</td></tr><tr><th>state_province</th><td>State/Province</td></tr><tr><th>token_values_map</th><td>Token Values Map</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pivot","full_name":"pivot","description":"\n<p>Translation missing: en.api.leads.category</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>status</th><td>Status</td></tr><tr><th>offer_id</th><td>Offer</td></tr><tr><th>schedule_id</th><td>Schedule</td></tr><tr><th>schedule_action_id</th><td>Schedule Action</td></tr><tr><th>buyer_converted_schedule_action_id</th><td>The schedule action where the lead converted.</td></tr><tr><th>lead_import_id</th><td>Lead Import</td></tr><tr><th>traffic_source_id</th><td>Traffic Source</td></tr><tr><th>outbound_calls_count</th><td>Outbound Calls Count</td></tr><tr><th>inbound_calls_count</th><td>Inbound Calls Count</td></tr><tr><th>recent_call_disposition_id</th><td>Recent Call Disposition</td></tr><tr><th>buyer_converted_days</th><td>Buyer Converted Days</td></tr><tr><th>buyer_id</th><td>Buyer</td></tr><tr><th>country</th><td>Country</td></tr><tr><th>call_center_id</th><td>Call Center</td></tr><tr><th>state</th><td>State</td></tr><tr><th>sub_id</th><td>Sub ID</td></tr><tr><th>dial_tier</th><td>Dial Tier</td></tr><tr><th>contact_field_type</th><td>Contact Field Type</td></tr><tr><th>created_at_day</th><td>The day the lead was submitted</td></tr><tr><th>created_at_month</th><td>The month the lead was submitted</td></tr><tr><th>created_at_week</th><td>The week the lead was submitted</td></tr><tr><th>created_at_five_minutes</th><td>The minute the lead was submitted</td></tr><tr><th>created_at_hour</th><td>The hour lead was submitted</td></tr><tr><th>schedule_trigger_type</th><td>Schedule Trigger Type</td></tr><tr><th>zip_postal_code</th><td>Zip/Postal Code</td></tr><tr><th>country</th><td>Country</td></tr><tr><th>state_province</th><td>State/Province</td></tr><tr><th>token_values_map</th><td>Token Values Map</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncaller_id\n</li>\n<li class='column-attempt'>\nemail\n</li>\n<li class='column-attempt'>\nfull_name\n</li>\n<li class='column-attempt'>\ncontact_field_type\n</li>\n<li class='column-attempt'>\nexpires_in\n</li>\n<li class='column-attempt'>\ncountry\n</li>\n<li class='column-attempt'>\nstate_province\n</li>\n<li class='column-attempt'>\nzip_postal_code\n</li>\n<li class='column-attempt'>\ntime_zone\n</li>\n<li class='column-attempt'>\nsub_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nhuman_status\n</li>\n<li class='column-attempt'>\ncss_status\n</li>\n<li class='column-attempt'>\nhas_next_action\n</li>\n<li class='column-attempt'>\nopt_out\n</li>\n<li class='column-attempt'>\nrevenue\n</li>\n<li class='column-attempt'>\npayout\n</li>\n<li class='column-attempt'>\noffer_converted\n</li>\n<li class='column-attempt'>\nbuyer_converted\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\nlead_import_id\n</li>\n<li class='column-attempt'>\nremote_ip\n</li>\n<li class='column-attempt'>\nattempted_call_id\n</li>\n<li class='column-attempt'>\nconnected_call_id\n</li>\n<li class='column-attempt'>\nscheduled_callback_id\n</li>\n<li class='column-attempt'>\ncall_buyer_conversion_id\n</li>\n<li class='column-attempt'>\ncall_offer_conversion_id\n</li>\n<li class='column-attempt'>\nsms_number_id\n</li>\n<li class='column-attempt'>\ndial_number_id\n</li>\n<li class='column-attempt'>\ndial_tier\n</li>\n<li class='column-attempt'>\nlast_action_at\n</li>\n<li class='column-attempt'>\nfirst_action_at\n</li>\n<li class='column-attempt'>\nfirst_queued_at\n</li>\n<li class='column-attempt'>\nschedule_ended_at\n</li>\n<li class='column-attempt'>\nnext_action_at\n</li>\n<li class='column-attempt'>\nlast_call_at\n</li>\n<li class='column-attempt'>\nis_live\n</li>\n<li class='column-attempt'>\nschedule_trigger_type\n</li>\n<li class='column-attempt'>\nblocked\n</li>\n<li class='column-attempt'>\ndata\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/leads/reports?category=buyer_id\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"leads_external":{"doc_url":"/api/docs/1.0/leads_external","id":"leads_external","api_url":"/api","name":"Lead By Third-Party","short_description":"Submit and manage the leads in your Trackdrive account from anywhere with CORS fully whitelisted. These endpoints allow you to submit or opt-out leads using AJAX on behalf of a user visiting your website.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/leads_external/create","name":"create","apis":[{"api_url":"/api/v1/leads","http_method":"POST","short_description":"Send leads to your Trackdrive account.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n<p>The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id","full_name":"caller_id","description":"\n<p>The callerID for the lead. This is the number Trackdrive will dial when making outbound calls to the lead. This is also the number where Trackdrive will send SMS.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n<p>The email address for the lead. The lead&#39;s email is required for sending emails from schedules to leads.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"contact_field_type","full_name":"contact_field_type","description":"\n<p>Pass an ID belonging to an <code>Agent Script &amp; Field Type</code> to select that <code>Custom Contact Field Type</code> for this call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_callback_at","full_name":"schedule_callback_at","description":"\n<p>Schedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\n<p>Schedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"update_all_matching_leads","full_name":"update_all_matching_leads","description":"\n<p>If this is true, then the data sent in this request will be applied to all leads that match the Offer or Schedule and caller_id sent in the request. An example usecase is if you are sending a tracking token and want it applied to a lead that is present on two schedules (auto, life) under one offer (insurance)</p>\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":[]},{"name":"apply_to","full_name":"apply_to","description":"\n<p>Should the data you&#39;re sending also be applied to calls associated with this lead?</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>calls</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"unblock_contact","full_name":"unblock_contact","description":"\n<p>Remove the caller_id from the company blacklist. Usage of this param requires passing an auth_token with permission to update Leads.</p>\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":[]},{"name":"blocked","full_name":"blocked","description":"\n<p>Set this to true in order to prevent this lead from calling any of your telephone numbers. This will also prevent all outbound actions from Trackdrive.</p>\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":[]},{"name":"assign_trackdrive_number","full_name":"assign_trackdrive_number","description":"\n<p>Assign a dialing number and return it in the API response as trackdrive_number_plain</p>\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":[]},{"name":"assign_sms_number","full_name":"assign_sms_number","description":"\n<p>Assign an SMS number and return it in the API response as sms_number_plain</p>\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":[]},{"name":"expire_existing","full_name":"expire_existing","description":"\n<p>Expire existing live schedule leads that match the lead_token and caller_id</p>\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":[]},{"name":"delete_existing","full_name":"delete_existing","description":"\n<p>Delete existing leads that match the lead_token and caller_id</p>\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":[]},{"name":"update_only","full_name":"update_only","description":"\n<p>Only update leads that are still active. When true Trackdrive will only update existing active leads. New leads will not be created. Leads that have completed all their actions will not be updated.</p>\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":[]},{"name":"lead_priority","full_name":"lead_priority","description":"\n<p>Defines the lead&#39;s priority for processing. Leads with lower values are processed first, influencing the order of scheduled actions such as calls, SMS, emails, and more.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"restart_schedule","full_name":"restart_schedule","description":"\n<p>Restart the schedule for the lead from the beginning.</p>\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":[]},{"name":"auto_format_nested_fields","full_name":"auto_format_nested_fields","description":"\n<p>Automatically extract contact fields that are nested inside non-standard incoming POST.</p>\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":[]},{"name":"next_action_at","full_name":"next_action_at","description":"\n<p>Change when the next action is scheduled to run. EG If you mistakenly scheduled leads to wait until next week, you can use this to bulk update them to run 1 second from now.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:57 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hours_to_expire","full_name":"hours_to_expire","description":"\n<p>Expire the lead after this many hours. The lead will exit schedule and perform end of schedule actions.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_contact_attempts","full_name":"max_contact_attempts","description":"\n<p>Expire the lead after this many outbound calls + SMS. The lead will exit schedule and perform end of schedule actions.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"data","full_name":"data","description":"\n<p>Trackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. <code>{interest: &#39;kittens&#39;, source: &#39;google&#39;, first_name: &#39;John&#39;, last_name: &#39;Smith&#39;}</code> Emails and SMS also have access to these tokens, so it&#39;s possible to send email and SMS messages that substitute tokens with values, such as {{first_name}}. Example SMS: “Hello {{first_name}} {{last_name}}, thanks for you inquiry. We will be calling you in 30 seconds from {{trackdrive_number}}”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\n# Submit leads with a simple HTTP request\ncurl -X POST trackdrive.com/api/v1/leads?lead_token=yourtoken&caller_id=17193132645&email=john@gmail.com&custom_token=the_value&loan_amount=500","\n# Submit leads as JSON:\ncurl -H \"Content-Type: application/json\" -X POST -d '{\"caller_id\":\"+18004506787\",\"data\":{\"loan_amount\":\"501\"}}' \"https://trackdrive.com/api/v1/leads?lead_token=yourtoken\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/caller_opt_out","name":"caller_opt_out","apis":[{"api_url":"/api/v1/leads/:caller_id/caller_opt_out","http_method":"PUT","short_description":"Mark a single lead as opt-out. Opted-out leads will no longer be sent SMS, Calls, or Emails.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n<p>The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X PUT -d '' trackdrive.com/api/v1/leads/17193132645/caller_opt_out?lead_token=yourtoken\n\n# GET requests are supported\ncurl trackdrive.com/api/v1/leads/17193132645/caller_opt_out?lead_token=yourtoken"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/caller_remove","name":"caller_remove","apis":[{"api_url":"/api/v1/leads/:caller_id/caller_remove","http_method":"POST","short_description":"Remove a single lead from a Schedule or Offer. This will prevent ANY additional actions being taken on behalf of the lead.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n<p>The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X POST trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken\ncurl -X DELETE trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken\n\n# GET requests are supported\ncurl trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/caller_move_to_end_of_schedule","name":"caller_move_to_end_of_schedule","apis":[{"api_url":"/api/v1/leads/:caller_id/caller_move_to_end_of_schedule","http_method":"PUT","short_description":"Move a lead to the end of it's schedule.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n<p>The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X POST -d '' trackdrive.com/api/v1/leads/17193132645/caller_move_to_end_of_schedule?lead_token=yourtoken"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"leads_next_actions":{"doc_url":"/api/docs/1.0/leads_next_actions","id":"leads_next_actions","api_url":"/api","name":"Leads: Scheduled Leads Queue","short_description":"Lists leads that are waiting before running their next schedule action.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/leads_next_actions/index","name":"index","apis":[{"api_url":"/api/v1/leads_next_actions","http_method":"GET","short_description":"List Scheduled Leads records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nnext_action_at\n</li>\n<li class='column-attempt'>\nwaiting\n</li>\n<li class='column-attempt'>\nrunning_at\n</li>\n<li class='column-attempt'>\nstatus_wait\n</li>\n<li class='column-attempt'>\nwhen_buyer_available\n</li>\n<li class='column-attempt'>\nsms_number_required\n</li>\n<li class='column-attempt'>\ndial_number_required\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_next_actions/show","name":"show","apis":[{"api_url":"/api/v1/leads_next_actions/:id","http_method":"GET","short_description":"Get Scheduled Leads by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"leads_no_match_actions":{"doc_url":"/api/docs/1.0/leads_no_match_actions","id":"leads_no_match_actions","api_url":"/api","name":"Leads: No Match Dial Queue","short_description":"List leads that are waiting for a call that don't match any agent or buyer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/leads_no_match_actions/index","name":"index","apis":[{"api_url":"/api/v1/leads_no_match_actions","http_method":"GET","short_description":"List Leads That Dont Match records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nnext_action_at\n</li>\n<li class='column-attempt'>\nstatus_wait\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_no_match_actions/show","name":"show","apis":[{"api_url":"/api/v1/leads_no_match_actions/:id","http_method":"GET","short_description":"Get Leads That Dont Match by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"map_contact_field_groups":{"doc_url":"/api/docs/1.0/map_contact_field_groups","id":"map_contact_field_groups","api_url":"/api","name":"Field Mapping Group","short_description":"API resource for managing Contact Field Mapping.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/map_contact_field_groups/index","name":"index","apis":[{"api_url":"/api/v1/map_contact_field_groups","http_method":"GET","short_description":"List Contact Field Mapping records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nmap_contact_fields_count\n</li>\n<li class='column-attempt'>\nmap_contact_field_values_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/new","name":"new","apis":[{"api_url":"/api/v1/map_contact_field_groups/new","http_method":"GET","short_description":"Build Contact Field Mapping with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/create","name":"create","apis":[{"api_url":"/api/v1/map_contact_field_groups","http_method":"POST","short_description":"Create Contact Field Mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/show","name":"show","apis":[{"api_url":"/api/v1/map_contact_field_groups/:id","http_method":"GET","short_description":"Get Contact Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/update","name":"update","apis":[{"api_url":"/api/v1/map_contact_field_groups/:id","http_method":"PUT","short_description":"Update Contact Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/map_contact_field_groups/:id","http_method":"DELETE","short_description":"Destroy Contact Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"map_contact_field_values":{"doc_url":"/api/docs/1.0/map_contact_field_values","id":"map_contact_field_values","api_url":"/api","name":"Field Value Mapping","short_description":"API resource for managing Field Value Mapping.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/map_contact_field_values/index","name":"index","apis":[{"api_url":"/api/v1/map_contact_field_values","http_method":"GET","short_description":"List Field Value Mapping records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nmap_contact_field_group_id\n</li>\n<li class='column-attempt'>\nmatching_values\n</li>\n<li class='column-attempt'>\nset_value_to\n</li>\n<li class='column-attempt'>\nmatching_key\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_values/new","name":"new","apis":[{"api_url":"/api/v1/map_contact_field_values/new","http_method":"GET","short_description":"Build Field Value Mapping with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_values/create","name":"create","apis":[{"api_url":"/api/v1/map_contact_field_values","http_method":"POST","short_description":"Create Field Value Mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_values/show","name":"show","apis":[{"api_url":"/api/v1/map_contact_field_values/:id","http_method":"GET","short_description":"Get Field Value Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_values/update","name":"update","apis":[{"api_url":"/api/v1/map_contact_field_values/:id","http_method":"PUT","short_description":"Update Field Value Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_values/destroy","name":"destroy","apis":[{"api_url":"/api/v1/map_contact_field_values/:id","http_method":"DELETE","short_description":"Destroy Field Value Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"map_contact_fields":{"doc_url":"/api/docs/1.0/map_contact_fields","id":"map_contact_fields","api_url":"/api","name":"Field Name Mapping","short_description":"API resource for managing Field Mapping.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/map_contact_fields/index","name":"index","apis":[{"api_url":"/api/v1/map_contact_fields","http_method":"GET","short_description":"List Field Mapping records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nmap_contact_field_group_id\n</li>\n<li class='column-attempt'>\nmatching_keys\n</li>\n<li class='column-attempt'>\nset_key_to\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_fields/new","name":"new","apis":[{"api_url":"/api/v1/map_contact_fields/new","http_method":"GET","short_description":"Build Field Mapping with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_fields/create","name":"create","apis":[{"api_url":"/api/v1/map_contact_fields","http_method":"POST","short_description":"Create Field Mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_fields/show","name":"show","apis":[{"api_url":"/api/v1/map_contact_fields/:id","http_method":"GET","short_description":"Get Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_fields/update","name":"update","apis":[{"api_url":"/api/v1/map_contact_fields/:id","http_method":"PUT","short_description":"Update Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_fields/destroy","name":"destroy","apis":[{"api_url":"/api/v1/map_contact_fields/:id","http_method":"DELETE","short_description":"Destroy Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"number_modifications":{"doc_url":"/api/docs/1.0/number_modifications","id":"number_modifications","api_url":"/api","name":"Number Modification","short_description":"API resource for managing Number Modification.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/number_modifications/index","name":"index","apis":[{"api_url":"/api/v1/number_modifications","http_method":"GET","short_description":"List Number Modification records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nring_pool_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nimport_file_url\n</li>\n<li class='column-attempt'>\nheaders\n</li>\n<li class='column-attempt'>\nerror_message\n</li>\n<li class='column-attempt'>\nimport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nstopped_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nnumber_modification_logs\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/new","name":"new","apis":[{"api_url":"/api/v1/number_modifications/new","http_method":"GET","short_description":"Build Number Modification with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Paused</p>\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":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Ring Pool</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Status</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"headers","full_name":"headers","description":"\n<p>Headers</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"error_message","full_name":"error_message","description":"\n<p>Error Message</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_count","full_name":"import_count","description":"\n<p>Import Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"total_count","full_name":"total_count","description":"\n<p>Total Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"started_at","full_name":"started_at","description":"\n<p>Started At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stopped_at","full_name":"stopped_at","description":"\n<p>Stopped At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/create","name":"create","apis":[{"api_url":"/api/v1/number_modifications","http_method":"POST","short_description":"Create Number Modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Paused</p>\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":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Ring Pool</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Status</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"headers","full_name":"headers","description":"\n<p>Headers</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"error_message","full_name":"error_message","description":"\n<p>Error Message</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_count","full_name":"import_count","description":"\n<p>Import Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"total_count","full_name":"total_count","description":"\n<p>Total Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"started_at","full_name":"started_at","description":"\n<p>Started At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stopped_at","full_name":"stopped_at","description":"\n<p>Stopped At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/show","name":"show","apis":[{"api_url":"/api/v1/number_modifications/:id","http_method":"GET","short_description":"Get Number Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/update","name":"update","apis":[{"api_url":"/api/v1/number_modifications/:id","http_method":"PUT","short_description":"Update Number Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Paused</p>\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":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Ring Pool</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n<p>Status</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"headers","full_name":"headers","description":"\n<p>Headers</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"error_message","full_name":"error_message","description":"\n<p>Error Message</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_count","full_name":"import_count","description":"\n<p>Import Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"total_count","full_name":"total_count","description":"\n<p>Total Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"started_at","full_name":"started_at","description":"\n<p>Started At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stopped_at","full_name":"stopped_at","description":"\n<p>Stopped At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/destroy","name":"destroy","apis":[{"api_url":"/api/v1/number_modifications/:id","http_method":"DELETE","short_description":"Destroy Number Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"number_order_prefixes":{"doc_url":"/api/docs/1.0/number_order_prefixes","id":"number_order_prefixes","api_url":"/api","name":"Number Order Prefix","short_description":"API resource for managing Number Order Prefix.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/number_order_prefixes/index","name":"index","apis":[{"api_url":"/api/v1/number_order_prefixes","http_method":"GET","short_description":"List Number Order Prefix records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nnumber_order_id\n</li>\n<li class='column-attempt'>\nprefix\n</li>\n<li class='column-attempt'>\norder_count\n</li>\n<li class='column-attempt'>\nnumbers_statuses\n</li>\n<li class='column-attempt'>\nnumber_ids\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/new","name":"new","apis":[{"api_url":"/api/v1/number_order_prefixes/new","http_method":"GET","short_description":"Build Number Order Prefix with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number_order_id","full_name":"number_order_id","description":"\n<p>Number Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Order}[/api/docs/1.0/number_orders/index.html]. Refer to: {/api/docs/1.0/number_orders}[/api/docs/1.0/number_orders/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"prefix","full_name":"prefix","description":"\n<p>Prefix</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_count","full_name":"order_count","description":"\n<p>Order Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>Sortable Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/create","name":"create","apis":[{"api_url":"/api/v1/number_order_prefixes","http_method":"POST","short_description":"Create Number Order Prefix.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number_order_id","full_name":"number_order_id","description":"\n<p>Number Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Order}[/api/docs/1.0/number_orders/index.html]. Refer to: {/api/docs/1.0/number_orders}[/api/docs/1.0/number_orders/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"prefix","full_name":"prefix","description":"\n<p>Prefix</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_count","full_name":"order_count","description":"\n<p>Order Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>Sortable Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/show","name":"show","apis":[{"api_url":"/api/v1/number_order_prefixes/:id","http_method":"GET","short_description":"Get Number Order Prefix by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/update","name":"update","apis":[{"api_url":"/api/v1/number_order_prefixes/:id","http_method":"PUT","short_description":"Update Number Order Prefix by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number_order_id","full_name":"number_order_id","description":"\n<p>Number Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Order}[/api/docs/1.0/number_orders/index.html]. Refer to: {/api/docs/1.0/number_orders}[/api/docs/1.0/number_orders/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"prefix","full_name":"prefix","description":"\n<p>Prefix</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_count","full_name":"order_count","description":"\n<p>Order Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>Sortable Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/destroy","name":"destroy","apis":[{"api_url":"/api/v1/number_order_prefixes/:id","http_method":"DELETE","short_description":"Destroy Number Order Prefix by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"number_orders":{"doc_url":"/api/docs/1.0/number_orders","id":"number_orders","api_url":"/api","name":"Number Order","short_description":"API resource for managing Number Orders.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/number_orders/index","name":"index","apis":[{"api_url":"/api/v1/number_orders","http_method":"GET","short_description":"List Number Orders.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nring_pool_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nprovider_configuration_id\n</li>\n<li class='column-attempt'>\nnumbers_count\n</li>\n<li class='column-attempt'>\nfallback_to_any_number_in_state\n</li>\n<li class='column-attempt'>\nnumber_order_prefix_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/new","name":"new","apis":[{"api_url":"/api/v1/number_orders/new","http_method":"GET","short_description":"Build Number Order with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.number_orders.offer_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Translation missing: en.api.number_orders.ring_pool_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Translation missing: en.api.number_orders.traffic_source_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Translation missing: en.api.number_orders.schedule_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"name","full_name":"name","description":"\n<p>Translation missing: en.api.number_orders.name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Translation missing: en.api.number_orders.description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Translation missing: en.api.number_orders.provider_configuration_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/create","name":"create","apis":[{"api_url":"/api/v1/number_orders","http_method":"POST","short_description":"Create Number Order.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.number_orders.offer_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Translation missing: en.api.number_orders.ring_pool_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Translation missing: en.api.number_orders.traffic_source_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Translation missing: en.api.number_orders.schedule_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"name","full_name":"name","description":"\n<p>Translation missing: en.api.number_orders.name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Translation missing: en.api.number_orders.description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Translation missing: en.api.number_orders.provider_configuration_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/show","name":"show","apis":[{"api_url":"/api/v1/number_orders/:id","http_method":"GET","short_description":"Get Number Order by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/update","name":"update","apis":[{"api_url":"/api/v1/number_orders/:id","http_method":"PUT","short_description":"Update Number Order by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.number_orders.offer_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Translation missing: en.api.number_orders.ring_pool_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Translation missing: en.api.number_orders.traffic_source_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Translation missing: en.api.number_orders.schedule_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"name","full_name":"name","description":"\n<p>Translation missing: en.api.number_orders.name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Translation missing: en.api.number_orders.description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Translation missing: en.api.number_orders.provider_configuration_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/destroy","name":"destroy","apis":[{"api_url":"/api/v1/number_orders/:id","http_method":"DELETE","short_description":"Destroy Number Order by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"number_ports":{"doc_url":"/api/docs/1.0/number_ports","id":"number_ports","api_url":"/api","name":"Translation missing: en.api.number_ports.resource.name","short_description":"Translation missing: en.api.number_ports.resource.short","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/number_ports/index","name":"index","apis":[{"api_url":"/api/v1/number_ports","http_method":"GET","short_description":"Translation missing: en.api.number_ports.index","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nnotes\n</li>\n<li class='column-attempt'>\ntarget_company_id\n</li>\n<li class='column-attempt'>\nnumber_list\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nstatus_report\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_ports/new","name":"new","apis":[{"api_url":"/api/v1/number_ports/new","http_method":"GET","short_description":"Translation missing: en.api.number_ports.new","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_ports/create","name":"create","apis":[{"api_url":"/api/v1/number_ports","http_method":"POST","short_description":"Translation missing: en.api.number_ports.create","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_ports/show","name":"show","apis":[{"api_url":"/api/v1/number_ports/:id","http_method":"GET","short_description":"Translation missing: en.api.number_ports.show","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"oauth_connections":{"doc_url":"/api/docs/1.0/oauth_connections","id":"oauth_connections","api_url":"/api","name":"Oauth Connection","short_description":"API resource for managing Oauth Connection.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/oauth_connections/index","name":"index","apis":[{"api_url":"/api/v1/oauth_connections","http_method":"GET","short_description":"List Oauth Connection records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\npredefined_type\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nclient_id\n</li>\n<li class='column-attempt'>\nwebhook_remote_url\n</li>\n<li class='column-attempt'>\nwebhook_remote_method\n</li>\n<li class='column-attempt'>\nwebhook_remote_body\n</li>\n<li class='column-attempt'>\nwebhook_remote_headers\n</li>\n<li class='column-attempt'>\nwebhook_read_timeout\n</li>\n<li class='column-attempt'>\nwebhook_response_success_codes\n</li>\n<li class='column-attempt'>\naccess_token_path\n</li>\n<li class='column-attempt'>\nexpires_in\n</li>\n<li class='column-attempt'>\nexpires_at\n</li>\n<li class='column-attempt'>\nfetched_at\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/new","name":"new","apis":[{"api_url":"/api/v1/oauth_connections/new","http_method":"GET","short_description":"Build Oauth Connection with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_id","full_name":"client_id","description":"\n<p>Client</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_secret","full_name":"client_secret","description":"\n<p>Client Secret</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\n<p>Webhook Remote Url</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\n<p>Webhook Remote Method</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\n<p>Webhook Remote Body</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\n<p>Webhook Remote Headers</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n<p>Webhook Read Timeout</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n<p>Webhook Response Success Codes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token_path","full_name":"access_token_path","description":"\n<p>Access Token Path</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token","full_name":"access_token","description":"\n<p>Access Token</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_in","full_name":"expires_in","description":"\n<p>Expires In</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"expires_at","description":"\n<p>Expires At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fetched_at","full_name":"fetched_at","description":"\n<p>Fetched At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/create","name":"create","apis":[{"api_url":"/api/v1/oauth_connections","http_method":"POST","short_description":"Create Oauth Connection.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_id","full_name":"client_id","description":"\n<p>Client</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_secret","full_name":"client_secret","description":"\n<p>Client Secret</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\n<p>Webhook Remote Url</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\n<p>Webhook Remote Method</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\n<p>Webhook Remote Body</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\n<p>Webhook Remote Headers</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n<p>Webhook Read Timeout</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n<p>Webhook Response Success Codes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token_path","full_name":"access_token_path","description":"\n<p>Access Token Path</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token","full_name":"access_token","description":"\n<p>Access Token</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_in","full_name":"expires_in","description":"\n<p>Expires In</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"expires_at","description":"\n<p>Expires At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fetched_at","full_name":"fetched_at","description":"\n<p>Fetched At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/show","name":"show","apis":[{"api_url":"/api/v1/oauth_connections/:id","http_method":"GET","short_description":"Get Oauth Connection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/update","name":"update","apis":[{"api_url":"/api/v1/oauth_connections/:id","http_method":"PUT","short_description":"Update Oauth Connection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_id","full_name":"client_id","description":"\n<p>Client</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_secret","full_name":"client_secret","description":"\n<p>Client Secret</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\n<p>Webhook Remote Url</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\n<p>Webhook Remote Method</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\n<p>Webhook Remote Body</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\n<p>Webhook Remote Headers</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n<p>Webhook Read Timeout</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n<p>Webhook Response Success Codes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token_path","full_name":"access_token_path","description":"\n<p>Access Token Path</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token","full_name":"access_token","description":"\n<p>Access Token</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_in","full_name":"expires_in","description":"\n<p>Expires In</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"expires_at","description":"\n<p>Expires At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fetched_at","full_name":"fetched_at","description":"\n<p>Fetched At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/destroy","name":"destroy","apis":[{"api_url":"/api/v1/oauth_connections/:id","http_method":"DELETE","short_description":"Destroy Oauth Connection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"offer_amd_flows":{"doc_url":"/api/docs/1.0/offer_amd_flows","id":"offer_amd_flows","api_url":"/api","name":"Offers: AMD Flows","short_description":"API resource for managing AMD Flows.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/offer_amd_flows/index","name":"index","apis":[{"api_url":"/api/v1/offer_amd_flows","http_method":"GET","short_description":"List AMD Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\ntoken_value_ids\n</li>\n<li class='column-attempt'>\nai_classification_matches\n</li>\n<li class='column-attempt'>\nai_speech_text_matches\n</li>\n<li class='column-attempt'>\napply_detected_type\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_amd_flows/new","name":"new","apis":[{"api_url":"/api/v1/offer_amd_flows/new","http_method":"GET","short_description":"Build AMD Flow with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.offer_amd_flows.offer_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Translation missing: en.api.offer_amd_flows.description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Translation missing: en.api.offer_amd_flows.record_token_filter_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.offer_amd_flows.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\n<p>If Classification Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_speech_text_matches","full_name":"ai_speech_text_matches","description":"\n<p>Or if Speech To Text Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_detected_type","full_name":"apply_detected_type","description":"\n<p>Then Apply This Behaviour. When a machine is detected agents will not be connected. When a human is detected, agents will prioritize connecting to the call.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_amd_flows/create","name":"create","apis":[{"api_url":"/api/v1/offer_amd_flows","http_method":"POST","short_description":"Create AMD Flow.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.offer_amd_flows.offer_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Translation missing: en.api.offer_amd_flows.description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Translation missing: en.api.offer_amd_flows.record_token_filter_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.offer_amd_flows.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\n<p>If Classification Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_speech_text_matches","full_name":"ai_speech_text_matches","description":"\n<p>Or if Speech To Text Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_detected_type","full_name":"apply_detected_type","description":"\n<p>Then Apply This Behaviour. When a machine is detected agents will not be connected. When a human is detected, agents will prioritize connecting to the call.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_amd_flows/show","name":"show","apis":[{"api_url":"/api/v1/offer_amd_flows/:id","http_method":"GET","short_description":"Get AMD Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_amd_flows/update","name":"update","apis":[{"api_url":"/api/v1/offer_amd_flows/:id","http_method":"PUT","short_description":"Update AMD Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.offer_amd_flows.offer_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Translation missing: en.api.offer_amd_flows.description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Translation missing: en.api.offer_amd_flows.record_token_filter_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Translation missing: en.api.offer_amd_flows.token_value_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\n<p>If Classification Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_speech_text_matches","full_name":"ai_speech_text_matches","description":"\n<p>Or if Speech To Text Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"apply_detected_type","full_name":"apply_detected_type","description":"\n<p>Then Apply This Behaviour. When a machine is detected agents will not be connected. When a human is detected, agents will prioritize connecting to the call.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_amd_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/offer_amd_flows/:id","http_method":"DELETE","short_description":"Destroy AMD Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"offer_conversions":{"doc_url":"/api/docs/1.0/offer_conversions","id":"offer_conversions","api_url":"/api","name":"Traffic Sources: Conversions","short_description":"The set of Traffic Source Conversions in your Trackdrive Account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/offer_conversions/index","name":"index","apis":[{"api_url":"/api/v1/offer_conversions","http_method":"GET","short_description":"List the Traffic Source Conversions in your Trackdrive Account.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer_conversion</th><td>Default response format.</td></tr><tr><th>offer_conversion_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>The conversion will be added to this offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_range_id","full_name":"business_range_id","description":"\n<p>The conversion will be added to these business hours. Leave this blank to automatically assign the currently open business hours.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days & Hours}[/api/docs/1.0//index.html]. Refer to: {/api/docs/1.0/}[/api/docs/1.0//index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\npayout\n</li>\n<li class='column-attempt'>\npayout_type\n</li>\n<li class='column-attempt'>\nrevenue_percentage\n</li>\n<li class='column-attempt'>\nduration\n</li>\n<li class='column-attempt'>\nduplicate_timeframe\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ntoken_values\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nbusiness_range_id\n</li>\n<li class='column-attempt'>\nconversion_type\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/offer_conversions?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/new","name":"new","apis":[{"api_url":"/api/v1/offer_conversions/new","http_method":"GET","short_description":"Build Traffic Source Payout with defaults.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer_conversion</th><td>Default response format.</td></tr><tr><th>offer_conversion_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/show","name":"show","apis":[{"api_url":"/api/v1/offer_conversions/:id","http_method":"GET","short_description":"Get a Traffic Source Conversion by ID.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer_conversion</th><td>Default response format.</td></tr><tr><th>offer_conversion_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/create","name":"create","apis":[{"api_url":"/api/v1/offer_conversions","http_method":"POST","short_description":"Create a Traffic Source Conversion.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer_conversion</th><td>Default response format.</td></tr><tr><th>offer_conversion_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payout_type","full_name":"payout_type","description":"\n<p>How should the payout be calculated?<br> <code>buyer_conversion_percent</code>: Calculate the payout as a percentage of the revenue paid to the buyer.<br> <code>usd</code>: Pay the Traffic Source this amount.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>usd</code>, <code>buyer_conversion_percent</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payout","full_name":"payout","description":"\n<p>The Traffic Source will be paid this amount when <code>payout_type</code> is set to <code>usd</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_percentage","full_name":"revenue_percentage","description":"\n<p>Calculate the payout as a percentage of the revenue paid to the buyer when <code>payout_type</code> is set to <code>buyer_conversion_percent</code>. A value of 60 would pay 60% of the revenue to the Traffic Source. If the buyer revenue is $15 and the percent is 60, the calculated payout would be $9</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duration","full_name":"duration","description":"\n<p>The number of seconds after the buyer answers the call before the traffic source gets paid. 0 seconds means the call will convert for the traffic source even if a buyer doesn&#39;t answer.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\n<p>The period of time that must elapse before a traffic source will be paid again when transferring the same CallerID.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>This name that will appear in your call logs when the call converts.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>The conversion will be added to this offer.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_range_id","full_name":"business_range_id","description":"\n<p>The conversion will be added to these business hours. Leave this blank to automatically assign the currently open business hours.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days & Hours}[/api/docs/1.0//index.html]. Refer to: {/api/docs/1.0/}[/api/docs/1.0//index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which Traffic Source Conversions will be checked for a matching conversion. Values are sorted in ascending order; smaller values are checked first.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"payout\": 10, \"duration\": 60, duplicate_timeframe: 3600, name: \"Pay $10 after 1 minute, deduped by 1 hour.\", offer_id: 10001234}' https://[your-subdomain].trackdrive.com/api/v1/offer_conversions"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/update","name":"update","apis":[{"api_url":"/api/v1/offer_conversions/:id","http_method":"PUT","short_description":"Update a Traffic Source Conversion by ID.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer_conversion</th><td>Default response format.</td></tr><tr><th>offer_conversion_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payout_type","full_name":"payout_type","description":"\n<p>How should the payout be calculated?<br> <code>buyer_conversion_percent</code>: Calculate the payout as a percentage of the revenue paid to the buyer.<br> <code>usd</code>: Pay the Traffic Source this amount.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>usd</code>, <code>buyer_conversion_percent</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payout","full_name":"payout","description":"\n<p>The Traffic Source will be paid this amount when <code>payout_type</code> is set to <code>usd</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_percentage","full_name":"revenue_percentage","description":"\n<p>Calculate the payout as a percentage of the revenue paid to the buyer when <code>payout_type</code> is set to <code>buyer_conversion_percent</code>. A value of 60 would pay 60% of the revenue to the Traffic Source. If the buyer revenue is $15 and the percent is 60, the calculated payout would be $9</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duration","full_name":"duration","description":"\n<p>The number of seconds after the buyer answers the call before the traffic source gets paid. 0 seconds means the call will convert for the traffic source even if a buyer doesn&#39;t answer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\n<p>The period of time that must elapse before a traffic source will be paid again when transferring the same CallerID.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>This name that will appear in your call logs when the call converts.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which Traffic Source Conversions will be checked for a matching conversion. Values are sorted in ascending order; smaller values are checked first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"payout\": 9, \"duration\": 120}' https://[your-subdomain].trackdrive.com/api/v1/offer_conversions/1008923"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/offer_conversions/:id","http_method":"DELETE","short_description":"Delete a Traffic Source Conversion by ID.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer_conversion</th><td>Default response format.</td></tr><tr><th>offer_conversion_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/offer_conversions/1008923\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"offers":{"doc_url":"/api/docs/1.0/offers","id":"offers","api_url":"/api","name":"Offers","short_description":"API resource for managing Offer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/offers/index","name":"index","apis":[{"api_url":"/api/v1/offers","http_method":"GET","short_description":"List Offer records.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer</th><td>Default response format.</td></tr><tr><th>offer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n<p>Sort results by this field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>name</code>, <code>schedules_count</code>, <code>numbers_count</code>, <code>buyers_count</code>, <code>agents_count</code>, <code>paused</code>, <code>user_offer_id</code>, <code>calls_count</code>, <code>recent_calls_count</code>, <code>last_call_at</code>, <code>numbers_count</code>, <code>created_at</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_dir","full_name":"order_dir","description":"\n<p>Sort results in ascending or descending order.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>asc</code>, <code>desc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nuser_offer_id\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\nnumbers_api_key\n</li>\n<li class='column-attempt'>\nleads_api_key\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nnumbers_count\n</li>\n<li class='column-attempt'>\nmax_cc_count\n</li>\n<li class='column-attempt'>\nactive_cc_count\n</li>\n<li class='column-attempt'>\nin_progress_count\n</li>\n<li class='column-attempt'>\ncall_routers_attributes\n</li>\n<li class='column-attempt'>\nlead_token\n</li>\n<li class='column-attempt'>\noffer_conversion_ids\n</li>\n<li class='column-attempt'>\nbuyers_count\n</li>\n<li class='column-attempt'>\nbuyer_groups_count\n</li>\n<li class='column-attempt'>\nagents_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_filter_blacklist_alliance_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_blacklist_alliance_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_blacklist_alliance_data\n</li>\n<li class='column-attempt'>\nrecord_token_filter_tcpa_shield_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_tcpa_shield_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_tcpa_shield_data\n</li>\n<li class='column-attempt'>\nrecord_token_filter_suppression_list_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_suppression_list_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_suppression_list_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/offers?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/show","name":"show","apis":[{"api_url":"/api/v1/offers/:id","http_method":"GET","short_description":"Get Offer by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer</th><td>Default response format.</td></tr><tr><th>offer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/new","name":"new","apis":[{"api_url":"/api/v1/offers/new","http_method":"GET","short_description":"Build Offer with defaults.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer</th><td>Default response format.</td></tr><tr><th>offer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/create","name":"create","apis":[{"api_url":"/api/v1/offers","http_method":"POST","short_description":"Create Offer.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer</th><td>Default response format.</td></tr><tr><th>offer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Give this offer a name. Example: Insurance Calls</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_offer_id","full_name":"user_offer_id","description":"\n<p>Give this offer a unique ID. Example: IC001</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>A human readable description of the record.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Pause or unpause the offer. Paused offers will reject all calls and disable all schedules.</p>\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":[]},{"name":"record_calls","full_name":"record_calls","description":"\n<p>Record Calls</p>\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":[]},{"name":"record_calls_require_authorization","full_name":"record_calls_require_authorization","description":"\n<p>Require the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.</p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/update","name":"update","apis":[{"api_url":"/api/v1/offers/:id","http_method":"PUT","short_description":"Update Offer by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer</th><td>Default response format.</td></tr><tr><th>offer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reset_numbers_api_key","full_name":"reset_numbers_api_key","description":"","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":[]},{"name":"name","full_name":"name","description":"\n<p>Give this offer a name. Example: Insurance Calls</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_offer_id","full_name":"user_offer_id","description":"\n<p>Give this offer a unique ID. Example: IC001</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>A human readable description of the record.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\n<p>Pause or unpause the offer. Paused offers will reject all calls and disable all schedules.</p>\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":[]},{"name":"record_calls","full_name":"record_calls","description":"\n<p>Record Calls</p>\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":[]},{"name":"record_calls_require_authorization","full_name":"record_calls_require_authorization","description":"\n<p>Require the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.</p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/offers/:id","http_method":"DELETE","short_description":"Destroy Offer by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>offer</th><td>Default response format.</td></tr><tr><th>offer_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"outgoing_webhook_urls":{"doc_url":"/api/docs/1.0/outgoing_webhook_urls","id":"outgoing_webhook_urls","api_url":"/api","name":"Outgoing Webhooks: URLs","short_description":"Configure the URLs that fire when an Outgoing Webhook is triggered.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/index","name":"index","apis":[{"api_url":"/api/v1/outgoing_webhook_urls","http_method":"GET","short_description":"List webhook urls","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Filter for urls that are assigned to this webhook.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\noutgoing_webhook_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nremote_url\n</li>\n<li class='column-attempt'>\nremote_method\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\npost_body\n</li>\n<li class='column-attempt'>\npost_headers\n</li>\n<li class='column-attempt'>\nresponse_parser_ids\n</li>\n<li class='column-attempt'>\nwebhook_params_count\n</li>\n<li class='column-attempt'>\nwebhook_read_timeout\n</li>\n<li class='column-attempt'>\nbuyer_ping_parser_ids\n</li>\n<li class='column-attempt'>\noutgoing_webhook_trigger_type\n</li>\n<li class='column-attempt'>\nhas_response_acceptance\n</li>\n<li class='column-attempt'>\ntoken_value_map_group_ids\n</li>\n<li class='column-attempt'>\nwebhook_response_success_codes\n</li>\n<li class='column-attempt'>\nwebhook_body_success_path\n</li>\n<li class='column-attempt'>\nwebhook_body_success_match\n</li>\n<li class='column-attempt'>\ncache_success_for_seconds\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/new","name":"new","apis":[{"api_url":"/api/v1/outgoing_webhook_urls/new","http_method":"GET","short_description":"Build a new webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Assign the record to this Outgoing Webhook.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_url","full_name":"remote_url","description":"\n<p>Remote URL</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_method","full_name":"remote_method","description":"\n<p>Remote Method</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>get</code>, <code>post</code>, <code>post_body</code>, <code>post_api_v1</code>, <code>put</code>, <code>delete</code>, <code>patch</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_body","full_name":"post_body","description":"\n<p>POST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: <code>{&quot;revenue&quot;:10, &quot;caller_id&quot;: &quot;1231231234&quot;}</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_headers","full_name":"post_headers","description":"\n<p>POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: <code>Content-Type: application/json</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/create","name":"create","apis":[{"api_url":"/api/v1/outgoing_webhook_urls","http_method":"POST","short_description":"Create a webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Assign the record to this Outgoing Webhook.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_url","full_name":"remote_url","description":"\n<p>Remote URL</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_method","full_name":"remote_method","description":"\n<p>Remote Method</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>get</code>, <code>post</code>, <code>post_body</code>, <code>post_api_v1</code>, <code>put</code>, <code>delete</code>, <code>patch</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_body","full_name":"post_body","description":"\n<p>POST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: <code>{&quot;revenue&quot;:10, &quot;caller_id&quot;: &quot;1231231234&quot;}</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_headers","full_name":"post_headers","description":"\n<p>POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: <code>Content-Type: application/json</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/show","name":"show","apis":[{"api_url":"/api/v1/outgoing_webhook_urls/:id","http_method":"GET","short_description":"Show the details of a webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/update","name":"update","apis":[{"api_url":"/api/v1/outgoing_webhook_urls/:id","http_method":"PUT","short_description":"Update a webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Assign the record to this Outgoing Webhook.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_url","full_name":"remote_url","description":"\n<p>Remote URL</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_method","full_name":"remote_method","description":"\n<p>Remote Method</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>get</code>, <code>post</code>, <code>post_body</code>, <code>post_api_v1</code>, <code>put</code>, <code>delete</code>, <code>patch</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_body","full_name":"post_body","description":"\n<p>POST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: <code>{&quot;revenue&quot;:10, &quot;caller_id&quot;: &quot;1231231234&quot;}</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"post_headers","full_name":"post_headers","description":"\n<p>POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: <code>Content-Type: application/json</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/destroy","name":"destroy","apis":[{"api_url":"/api/v1/outgoing_webhook_urls/:id","http_method":"DELETE","short_description":"Delete a webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"outgoing_webhooks":{"doc_url":"/api/docs/1.0/outgoing_webhooks","id":"outgoing_webhooks","api_url":"/api","name":"Outgoing Webhooks","short_description":"Webhooks (also known as Postbacks) fire when a triggers occurs, such as a buyer being dialed or a call ending.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/outgoing_webhooks/index","name":"index","apis":[{"api_url":"/api/v1/outgoing_webhooks","http_method":"GET","short_description":"List webhooks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Filter for webhooks that are assigned to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Translation missing: en.api.outgoing_webhooks.buyer_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Filter for webhooks that are assigned to this Schedule Action.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_type","full_name":"trigger_type","description":"\n<p>When does this trigger fire?</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>agent_enter_conference</code>, <code>agent_exit_conference</code>, <code>agent_offline</code>, <code>agent_online</code>, <code>before_answering_call</code>, <code>before_placing_call</code>, <code>before_schedule_action_dial</code>, <code>before_sending_text_message</code>, <code>both_converted</code>, <code>buyer_answered</code>, <code>buyer_answered_with_contact_fields</code>, <code>buyer_before_dial</code>, <code>buyer_converted</code>, <code>buyer_dialled</code>, <code>buyer_did_not_convert</code>, <code>buyer_enter_conference</code>, <code>buyer_exit_conference</code>, <code>call_changed</code>, <code>call_disposition_changed</code>, <code>call_recording_updated</code>, <code>consumer_enter_conference</code>, <code>consumer_exit_conference</code>, <code>contact_fields_changed</code>, <code>did_not_convert</code>, <code>either_converted</code>, <code>every_call</code>, <code>lead_changed</code>, <code>lead_opted_out</code>, <code>new_call_started</code>, <code>new_lead_created</code>, <code>offer_converted</code>, <code>offer_did_not_convert</code>, <code>only_buyer_converted</code>, <code>only_offer_converted</code>, <code>timer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ntrigger_type\n</li>\n<li class='column-attempt'>\ntrigger_duration\n</li>\n<li class='column-attempt'>\ntier\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\noffer_name\n</li>\n<li class='column-attempt'>\nschedule_action_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\noutgoing_url_ids\n</li>\n<li class='column-attempt'>\ntoken_value_map_ids\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nbuyer_group_id\n</li>\n<li class='column-attempt'>\ncall_router_id\n</li>\n<li class='column-attempt'>\nglobal_company_id\n</li>\n<li class='column-attempt'>\nbuyer_name\n</li>\n<li class='column-attempt'>\ntraffic_source_name\n</li>\n<li class='column-attempt'>\nbuyer_group_name\n</li>\n<li class='column-attempt'>\ntrigger_call_status\n</li>\n<li class='column-attempt'>\ncache_success_for_seconds\n</li>\n<li class='column-attempt'>\nwebhook_body_success_path\n</li>\n<li class='column-attempt'>\nwebhook_body_success_match\n</li>\n<li class='column-attempt'>\nwebhook_path_number\n</li>\n<li class='column-attempt'>\nconnected_duration_seconds\n</li>\n<li class='column-attempt'>\nwebhook_path_duration\n</li>\n<li class='column-attempt'>\nwebhook_path_name\n</li>\n<li class='column-attempt'>\nwebhook_path_revenue\n</li>\n<li class='column-attempt'>\nwebhook_response_success_codes\n</li>\n<li class='column-attempt'>\nwebhook_path_buyer_name\n</li>\n<li class='column-attempt'>\nwebhook_path_external_id\n</li>\n<li class='column-attempt'>\nbuyer_answered_with_contact_field_ids\n</li>\n<li class='column-attempt'>\nwebhook_contains_many_buyers\n</li>\n<li class='column-attempt'>\nwebhook_path_buyers\n</li>\n<li class='column-attempt'>\ntemplate_description\n</li>\n<li class='column-attempt'>\ntemplate_enabled\n</li>\n<li class='column-attempt'>\ntemplate_tier\n</li>\n<li class='column-attempt'>\ntemplate_copy_on_company_create\n</li>\n<li class='column-attempt'>\ncall_router_answer_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nwebhook_action_ids\n</li>\n<li class='column-attempt'>\ntoken_value_map_group_ids\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n<li class='column-attempt'>\nwebhook_manual_fire_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhooks/new","name":"new","apis":[{"api_url":"/api/v1/outgoing_webhooks/new","http_method":"GET","short_description":"Build a new webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"global_company_id","full_name":"global_company_id","description":"\n<p>Assign the webhook to your company to have it fire on all calls.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Company}[/api/docs/1.0/companies/index.html]. Refer to: {/api/docs/1.0/companies}[/api/docs/1.0/companies/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Translation missing: en.api.outgoing_webhooks.buyer_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_id","full_name":"call_router_id","description":"\n<p>Translation missing: en.api.outgoing_webhooks.call_router_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Flow}[/api/docs/1.0/call_routers/index.html]. Refer to: {/api/docs/1.0/call_routers}[/api/docs/1.0/call_routers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Assign the record to this Schedule Action.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_type","full_name":"trigger_type","description":"\n<p>When does this trigger fire?</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>agent_enter_conference</code>, <code>agent_exit_conference</code>, <code>agent_offline</code>, <code>agent_online</code>, <code>before_answering_call</code>, <code>before_placing_call</code>, <code>before_schedule_action_dial</code>, <code>before_sending_text_message</code>, <code>both_converted</code>, <code>buyer_answered</code>, <code>buyer_answered_with_contact_fields</code>, <code>buyer_before_dial</code>, <code>buyer_converted</code>, <code>buyer_dialled</code>, <code>buyer_did_not_convert</code>, <code>buyer_enter_conference</code>, <code>buyer_exit_conference</code>, <code>call_changed</code>, <code>call_disposition_changed</code>, <code>call_recording_updated</code>, <code>consumer_enter_conference</code>, <code>consumer_exit_conference</code>, <code>contact_fields_changed</code>, <code>did_not_convert</code>, <code>either_converted</code>, <code>every_call</code>, <code>lead_changed</code>, <code>lead_opted_out</code>, <code>new_call_started</code>, <code>new_lead_created</code>, <code>offer_converted</code>, <code>offer_did_not_convert</code>, <code>only_buyer_converted</code>, <code>only_offer_converted</code>, <code>timer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_duration","full_name":"trigger_duration","description":"\n<p>How many seconds must pass for the trigger to fire?</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhooks/create","name":"create","apis":[{"api_url":"/api/v1/outgoing_webhooks","http_method":"POST","short_description":"Create a webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"global_company_id","full_name":"global_company_id","description":"\n<p>Assign the webhook to your company to have it fire on all calls.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Company}[/api/docs/1.0/companies/index.html]. Refer to: {/api/docs/1.0/companies}[/api/docs/1.0/companies/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Translation missing: en.api.outgoing_webhooks.buyer_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_id","full_name":"call_router_id","description":"\n<p>Translation missing: en.api.outgoing_webhooks.call_router_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Flow}[/api/docs/1.0/call_routers/index.html]. Refer to: {/api/docs/1.0/call_routers}[/api/docs/1.0/call_routers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Assign the record to this Schedule Action.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_type","full_name":"trigger_type","description":"\n<p>When does this trigger fire?</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>agent_enter_conference</code>, <code>agent_exit_conference</code>, <code>agent_offline</code>, <code>agent_online</code>, <code>before_answering_call</code>, <code>before_placing_call</code>, <code>before_schedule_action_dial</code>, <code>before_sending_text_message</code>, <code>both_converted</code>, <code>buyer_answered</code>, <code>buyer_answered_with_contact_fields</code>, <code>buyer_before_dial</code>, <code>buyer_converted</code>, <code>buyer_dialled</code>, <code>buyer_did_not_convert</code>, <code>buyer_enter_conference</code>, <code>buyer_exit_conference</code>, <code>call_changed</code>, <code>call_disposition_changed</code>, <code>call_recording_updated</code>, <code>consumer_enter_conference</code>, <code>consumer_exit_conference</code>, <code>contact_fields_changed</code>, <code>did_not_convert</code>, <code>either_converted</code>, <code>every_call</code>, <code>lead_changed</code>, <code>lead_opted_out</code>, <code>new_call_started</code>, <code>new_lead_created</code>, <code>offer_converted</code>, <code>offer_did_not_convert</code>, <code>only_buyer_converted</code>, <code>only_offer_converted</code>, <code>timer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_duration","full_name":"trigger_duration","description":"\n<p>How many seconds must pass for the trigger to fire?</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>The human friendly name of this webhook.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhooks/show","name":"show","apis":[{"api_url":"/api/v1/outgoing_webhooks/:id","http_method":"GET","short_description":"Show the details of a webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhooks/update","name":"update","apis":[{"api_url":"/api/v1/outgoing_webhooks/:id","http_method":"PUT","short_description":"Update a webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"global_company_id","full_name":"global_company_id","description":"\n<p>Assign the webhook to your company to have it fire on all calls.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Company}[/api/docs/1.0/companies/index.html]. Refer to: {/api/docs/1.0/companies}[/api/docs/1.0/companies/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Translation missing: en.api.outgoing_webhooks.buyer_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_id","full_name":"call_router_id","description":"\n<p>Translation missing: en.api.outgoing_webhooks.call_router_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Flow}[/api/docs/1.0/call_routers/index.html]. Refer to: {/api/docs/1.0/call_routers}[/api/docs/1.0/call_routers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Assign the record to this Schedule Action.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_type","full_name":"trigger_type","description":"\n<p>When does this trigger fire?</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>agent_enter_conference</code>, <code>agent_exit_conference</code>, <code>agent_offline</code>, <code>agent_online</code>, <code>before_answering_call</code>, <code>before_placing_call</code>, <code>before_schedule_action_dial</code>, <code>before_sending_text_message</code>, <code>both_converted</code>, <code>buyer_answered</code>, <code>buyer_answered_with_contact_fields</code>, <code>buyer_before_dial</code>, <code>buyer_converted</code>, <code>buyer_dialled</code>, <code>buyer_did_not_convert</code>, <code>buyer_enter_conference</code>, <code>buyer_exit_conference</code>, <code>call_changed</code>, <code>call_disposition_changed</code>, <code>call_recording_updated</code>, <code>consumer_enter_conference</code>, <code>consumer_exit_conference</code>, <code>contact_fields_changed</code>, <code>did_not_convert</code>, <code>either_converted</code>, <code>every_call</code>, <code>lead_changed</code>, <code>lead_opted_out</code>, <code>new_call_started</code>, <code>new_lead_created</code>, <code>offer_converted</code>, <code>offer_did_not_convert</code>, <code>only_buyer_converted</code>, <code>only_offer_converted</code>, <code>timer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_duration","full_name":"trigger_duration","description":"\n<p>How many seconds must pass for the trigger to fire?</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhooks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/outgoing_webhooks/:id","http_method":"DELETE","short_description":"Delete a webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pgbouncer_databases":{"doc_url":"/api/docs/1.0/pgbouncer_databases","id":"pgbouncer_databases","api_url":"/api","name":"PgBouncer Database","short_description":"API resource for managing PgBouncer Database.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/pgbouncer_databases/index","name":"index","apis":[{"api_url":"/api/v1/pgbouncer_databases","http_method":"GET","short_description":"List PgBouncer Database records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nactive\n</li>\n<li class='column-attempt'>\npgbouncer_database_key\n</li>\n<li class='column-attempt'>\npg_host\n</li>\n<li class='column-attempt'>\npg_port\n</li>\n<li class='column-attempt'>\npg_dbname\n</li>\n<li class='column-attempt'>\npg_user\n</li>\n<li class='column-attempt'>\nshard_type\n</li>\n<li class='column-attempt'>\nshard_cluster_id\n</li>\n<li class='column-attempt'>\nshard_previous_cluster_id\n</li>\n<li class='column-attempt'>\nshard_physical_at\n</li>\n<li class='column-attempt'>\ndelete_rows_enabled\n</li>\n<li class='column-attempt'>\ndelete_rows_succeeded_at\n</li>\n<li class='column-attempt'>\ndedicated_application_cluster\n</li>\n<li class='column-attempt'>\ncurrent_delete_rows_table_name_last_id\n</li>\n<li class='column-attempt'>\nserver_role\n</li>\n<li class='column-attempt'>\ncategory\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/pgbouncer_databases/new","name":"new","apis":[{"api_url":"/api/v1/pgbouncer_databases/new","http_method":"GET","short_description":"Build PgBouncer Database with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/pgbouncer_databases/create","name":"create","apis":[{"api_url":"/api/v1/pgbouncer_databases","http_method":"POST","short_description":"Create PgBouncer Database.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/pgbouncer_databases/show","name":"show","apis":[{"api_url":"/api/v1/pgbouncer_databases/:id","http_method":"GET","short_description":"Get PgBouncer Database by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/pgbouncer_databases/update","name":"update","apis":[{"api_url":"/api/v1/pgbouncer_databases/:id","http_method":"PUT","short_description":"Update PgBouncer Database by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"phone_numbers":{"doc_url":"/api/docs/1.0/phone_numbers","id":"phone_numbers","api_url":"/api","name":"Phone numbers","short_description":"The phone numbers in your Trackdrive account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/phone_numbers/index","name":"index","apis":[{"api_url":"/api/v1/phone_numbers","http_method":"GET","short_description":"Get the phone numbers assigned to your account.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>number</th><td>Default response format.</td></tr><tr><th>number_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nnumber\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nprovider_configuration_id\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nring_pool_id\n</li>\n<li class='column-attempt'>\nprovider_auth_key\n</li>\n<li class='column-attempt'>\nlast_call_at\n</li>\n<li class='column-attempt'>\ntoken_values\n</li>\n<li class='column-attempt'>\ncountry\n</li>\n<li class='column-attempt'>\narea_code_id\n</li>\n<li class='column-attempt'>\noptimizer_displayed_at\n</li>\n<li class='column-attempt'>\noptimizer_tokens_changed_at\n</li>\n<li class='column-attempt'>\nplain_number\n</li>\n<li class='column-attempt'>\nextension\n</li>\n<li class='column-attempt'>\nchecksum\n</li>\n<li class='column-attempt'>\nhuman_number\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]},{"name":"number","full_name":"number","description":"\n<p>The phone number.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Refer to the provider api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Refer to the Number Pool api for details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_call_at_to","full_name":"last_call_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_call_at_from","full_name":"last_call_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/phone_numbers?number=+441224980000&\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/phone_numbers/create","name":"create","apis":[{"api_url":"/api/v1/phone_numbers","http_method":"POST","short_description":"Purchase a new phone number using one of your existing provider configurations.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>number</th><td>Default response format.</td></tr><tr><th>number_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Refer to the provider api for details</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"toll_free","full_name":"toll_free","description":"\n<p>Purchase a toll-free or local number? true for toll-free, false for local number.</p>\n","required":true,"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":[]},{"name":"country","full_name":"country","description":"\n<p>The country where the number will be purchased.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>AR</code>, <code>AT</code>, <code>AU</code>, <code>BE</code>, <code>BG</code>, <code>BH</code>, <code>BR</code>, <code>CA</code>, <code>CH</code>, <code>CL</code>, <code>CN</code>, <code>CO</code>, <code>CY</code>, <code>CZ</code>, <code>DE</code>, <code>DK</code>, <code>DO</code>, <code>EE</code>, <code>ES</code>, <code>FI</code>, <code>FR</code>, <code>GB</code>, <code>GE</code>, <code>GR</code>, <code>HK</code>, <code>HR</code>, <code>HU</code>, <code>ID</code>, <code>IE</code>, <code>IL</code>, <code>IT</code>, <code>JP</code>, <code>KR</code>, <code>LT</code>, <code>LU</code>, <code>LV</code>, <code>MT</code>, <code>MX</code>, <code>MY</code>, <code>NL</code>, <code>NO</code>, <code>NZ</code>, <code>PA</code>, <code>PE</code>, <code>PH</code>, <code>PK</code>, <code>PL</code>, <code>PR</code>, <code>PT</code>, <code>RO</code>, <code>RU</code>, <code>SE</code>, <code>SG</code>, <code>SI</code>, <code>SK</code>, <code>SV</code>, <code>TR</code>, <code>US</code>, <code>ZA</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Refer to the Number Pool api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_override_lead_traffic_source","full_name":"traffic_source_override_lead_traffic_source","description":"\n<p>Force Calls to Credit This Traffic Source and Extra Tokens, even if Lead Traffic Source or Data is Different</p>\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":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{provider_configuration_id: 150, offer_id: 100, toll_free: true, country: 'US'}' https://[your-subdomain].trackdrive.com/api/v1/phone_numbers.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/phone_numbers/show","name":"show","apis":[{"api_url":"/api/v1/phone_numbers/:id","http_method":"GET","short_description":"Show the details of phone number","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>number</th><td>Default response format.</td></tr><tr><th>number_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>This can be either the internal trackdrive id or the full phone number beginning with &#39;+&#39;<br> For example:<br> To find a number using trackdrive&#39;s internal id pass <code>id=185923</code><br> To find a number using the phone number pass <code>id=+18005002562&quot;</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" https://[your-subdomain].trackdrive.com/api/v1/phone_numbers/20590"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/phone_numbers/update","name":"update","apis":[{"api_url":"/api/v1/phone_numbers/:id","http_method":"PUT","short_description":"Update a phone number's traffic source or Number Pool","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>number</th><td>Default response format.</td></tr><tr><th>number_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>This can be either the internal trackdrive id or the full phone number beginning with &#39;+&#39;<br> For example:<br> To find a number using trackdrive&#39;s internal id pass <code>id=185923</code><br> To find a number using the phone number pass <code>id=+18005002562&quot;</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Refer to the Number Pool api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_override_lead_traffic_source","full_name":"traffic_source_override_lead_traffic_source","description":"\n<p>Force Calls to Credit This Traffic Source and Extra Tokens, even if Lead Traffic Source or Data is Different</p>\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":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"traffic_source_id\":\"1002592\"}' https://[your-subdomain].trackdrive.com/api/v1/phone_numbers/:id"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/phone_numbers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/phone_numbers/:id","http_method":"DELETE","short_description":"Unrent a phone number.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>number</th><td>Default response format.</td></tr><tr><th>number_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n<p>This can be either the internal trackdrive id or the full phone number beginning with &#39;+&#39;<br> For example:<br> To find a number using trackdrive&#39;s internal id pass <code>id=185923</code><br> To find a number using the phone number pass <code>id=+18005002562&quot;</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE https://[your-subdomain].trackdrive.com/api/v1/phone_numbers/:id"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"provider_configurations":{"doc_url":"/api/docs/1.0/provider_configurations","id":"provider_configurations","api_url":"/api","name":"Provider Configuration","short_description":"API resource for managing Provider Configuration.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/provider_configurations/index","name":"index","apis":[{"api_url":"/api/v1/provider_configurations","http_method":"GET","short_description":"List Provider Configuration records.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>provider_configuration</th><td>Provider Configuration</td></tr><tr><th>provider_configuration_grid</th><td>Provider Configuration Grid</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nprovider_auto_recharge\n</li>\n<li class='column-attempt'>\nprovider_user_name\n</li>\n<li class='column-attempt'>\nprovider_app\n</li>\n<li class='column-attempt'>\nis_default\n</li>\n<li class='column-attempt'>\nprovider_type\n</li>\n<li class='column-attempt'>\nnumbers_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]},{"name":"order","full_name":"order","description":"\n<p>Sort results by this field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>id</code>, <code>type</code>, <code>name</code>, <code>created_at</code>, <code>updated_at</code>, <code>deleted_at</code>, <code>max_requests_per_interval</code>, <code>max_requests_per_caller</code>, <code>max_requests_per_number</code>, <code>max_requests_per_provider</code>, <code>requests_interval_for_caller</code>, <code>requests_interval_for_number</code>, <code>requests_interval_for_provider</code>, <code>max_requests_per_second</code>, <code>block_rate_limited_caller</code>, <code>is_default</code>, <code>max_requests_per_npa_nxx</code>, <code>requests_interval_for_npa_nxx</code>, <code>numbers_count</code>, <code>last_call_at</code>, <code>calls_count</code>, <code>recent_calls_count</code>, <code>disconnected_at</code>, <code>connected_status</code>, <code>connected_at</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/provider_configurations/show","name":"show","apis":[{"api_url":"/api/v1/provider_configurations/:id","http_method":"GET","short_description":"Get Provider Configuration by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>provider_configuration</th><td>Provider Configuration</td></tr><tr><th>provider_configuration_grid</th><td>Provider Configuration Grid</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/provider_configurations/update","name":"update","apis":[{"api_url":"/api/v1/provider_configurations/:id","http_method":"PUT","short_description":"Update Provider Configuration by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>provider_configuration</th><td>Provider Configuration</td></tr><tr><th>provider_configuration_grid</th><td>Provider Configuration Grid</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_default","full_name":"is_default","description":"\n<p>Is Default</p>\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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"is_default\":\"true\", \"name\": \"New Name\"}' https://[your-subdomain].trackdrive.com/api/v1/provider_configurations/:id"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"rates":{"doc_url":"/api/docs/1.0/rates","id":"rates","api_url":"/api","name":"Rates","short_description":"TrackDrive Rates.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/rates/show_by_number","name":"show_by_number","apis":[{"api_url":"/api/v1/rates/:number","http_method":"GET","short_description":"Get the rate to call a telephone number.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number","full_name":"number","description":"\n<p>A telephone number like 17191231234</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"record_token_filters":{"doc_url":"/api/docs/1.0/record_token_filters","id":"record_token_filters","api_url":"/api","name":"Filter Group","short_description":"API resource for managing Filter Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/record_token_filters/index","name":"index","apis":[{"api_url":"/api/v1/record_token_filters","http_method":"GET","short_description":"List Filter Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nowner_name\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nrecord_token_params_count\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n<li class='column-attempt'>\nowner_id\n</li>\n<li class='column-attempt'>\nowner_method_name\n</li>\n<li class='column-attempt'>\nowner_relation\n</li>\n<li class='column-attempt'>\nwith_operators\n</li>\n<li class='column-attempt'>\nequals_buyer_ids\n</li>\n<li class='column-attempt'>\nequals_traffic_source_ids\n</li>\n<li class='column-attempt'>\nequals_buyer_group_ids\n</li>\n<li class='column-attempt'>\nequals_offer_ids\n</li>\n<li class='column-attempt'>\nequals_number_ids\n</li>\n<li class='column-attempt'>\nequals_schedule_ids\n</li>\n<li class='column-attempt'>\nequals_lead_import_ids\n</li>\n<li class='column-attempt'>\nequals_zip_code_list_ids\n</li>\n<li class='column-attempt'>\nequals_area_codes\n</li>\n<li class='column-attempt'>\nequals_countries\n</li>\n<li class='column-attempt'>\nequals_states\n</li>\n<li class='column-attempt'>\ntoggle_equals_buyer_ids\n</li>\n<li class='column-attempt'>\ntoggle_equals_traffic_source_ids\n</li>\n<li class='column-attempt'>\ntoggle_equals_buyer_group_ids\n</li>\n<li class='column-attempt'>\ntoggle_equals_offer_ids\n</li>\n<li class='column-attempt'>\ntoggle_equals_number_ids\n</li>\n<li class='column-attempt'>\ntoggle_equals_schedule_ids\n</li>\n<li class='column-attempt'>\ntoggle_equals_lead_import_ids\n</li>\n<li class='column-attempt'>\ntoggle_equals_zip_code_list_ids\n</li>\n<li class='column-attempt'>\ntoggle_equals_area_codes\n</li>\n<li class='column-attempt'>\ntoggle_equals_countries\n</li>\n<li class='column-attempt'>\ntoggle_equals_states\n</li>\n<li class='column-attempt'>\ngeo_csv_text\n</li>\n<li class='column-attempt'>\ntoggle_equals_geo_csv_text\n</li>\n<li class='column-attempt'>\npredefined_filters\n</li>\n<li class='column-attempt'>\ndata_count\n</li>\n<li class='column-attempt'>\nhas_record_token_params\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_filters/new","name":"new","apis":[{"api_url":"/api/v1/record_token_filters/new","http_method":"GET","short_description":"Build Filter Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"owner_type","full_name":"owner_type","description":"\n<p>The type of record that owns this record.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_filters/show","name":"show","apis":[{"api_url":"/api/v1/record_token_filters/:id","http_method":"GET","short_description":"Get Filter Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_filters/update","name":"update","apis":[{"api_url":"/api/v1/record_token_filters/:id","http_method":"PUT","short_description":"Update Filter Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"toggle_equals_buyer_ids","full_name":"toggle_equals_buyer_ids","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_buyer_ids</p>\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":[]},{"name":"toggle_equals_traffic_source_ids","full_name":"toggle_equals_traffic_source_ids","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_traffic_source_ids</p>\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":[]},{"name":"toggle_equals_buyer_group_ids","full_name":"toggle_equals_buyer_group_ids","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_buyer_group_ids</p>\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":[]},{"name":"toggle_equals_offer_ids","full_name":"toggle_equals_offer_ids","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_offer_ids</p>\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":[]},{"name":"toggle_equals_number_ids","full_name":"toggle_equals_number_ids","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_number_ids</p>\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":[]},{"name":"toggle_equals_schedule_ids","full_name":"toggle_equals_schedule_ids","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_schedule_ids</p>\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":[]},{"name":"toggle_equals_lead_import_ids","full_name":"toggle_equals_lead_import_ids","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_lead_import_ids</p>\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":[]},{"name":"toggle_equals_zip_code_list_ids","full_name":"toggle_equals_zip_code_list_ids","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_zip_code_list_ids</p>\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":[]},{"name":"toggle_equals_area_codes","full_name":"toggle_equals_area_codes","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_area_codes</p>\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":[]},{"name":"toggle_equals_countries","full_name":"toggle_equals_countries","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_countries</p>\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":[]},{"name":"toggle_equals_states","full_name":"toggle_equals_states","description":"\n<p>Translation missing: en.api.record_token_filters.toggle_equals_states</p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"record_token_params":{"doc_url":"/api/docs/1.0/record_token_params","id":"record_token_params","api_url":"/api","name":"Filter","short_description":"API resource for managing Filter.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/record_token_params/index","name":"index","apis":[{"api_url":"/api/v1/record_token_params","http_method":"GET","short_description":"List Filter records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nvalue\n</li>\n<li class='column-attempt'>\noperator\n</li>\n<li class='column-attempt'>\nbackground_color\n</li>\n<li class='column-attempt'>\ntext_color\n</li>\n<li class='column-attempt'>\ncss_styles\n</li>\n<li class='column-attempt'>\nwith_operators\n</li>\n<li class='column-attempt'>\nvalues\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_params/new","name":"new","apis":[{"api_url":"/api/v1/record_token_params/new","http_method":"GET","short_description":"Build Filter with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_params/create","name":"create","apis":[{"api_url":"/api/v1/record_token_params","http_method":"POST","short_description":"Create Filter.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_params/show","name":"show","apis":[{"api_url":"/api/v1/record_token_params/:id","http_method":"GET","short_description":"Get Filter by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_params/update","name":"update","apis":[{"api_url":"/api/v1/record_token_params/:id","http_method":"PUT","short_description":"Update Filter by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_params/destroy","name":"destroy","apis":[{"api_url":"/api/v1/record_token_params/:id","http_method":"DELETE","short_description":"Destroy Filter by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"record_token_pickers":{"doc_url":"/api/docs/1.0/record_token_pickers","id":"record_token_pickers","api_url":"/api","name":"Token Picker","short_description":"API resource for managing Token Picker.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/record_token_pickers/show","name":"show","apis":[{"api_url":"/api/v1/record_token_pickers/:id","http_method":"GET","short_description":"Get Token Picker by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_pickers/update","name":"update","apis":[{"api_url":"/api/v1/record_token_pickers/:id","http_method":"PUT","short_description":"Update Token Picker by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"record_wizards":{"doc_url":"/api/docs/1.0/record_wizards","id":"record_wizards","api_url":"/api","name":"Template","short_description":"API resource for managing Template.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/record_wizards/index","name":"index","apis":[{"api_url":"/api/v1/record_wizards","http_method":"GET","short_description":"List Template records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nowner_id\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n<li class='column-attempt'>\ntemplate_record_id\n</li>\n<li class='column-attempt'>\ntemplate_record_uuid\n</li>\n<li class='column-attempt'>\ncommon_attributes\n</li>\n<li class='column-attempt'>\nrelation\n</li>\n<li class='column-attempt'>\ndestroy_current_records\n</li>\n<li class='column-attempt'>\nrecent_log_messages\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nowner_name\n</li>\n<li class='column-attempt'>\nrecord_wizards_count\n</li>\n<li class='column-attempt'>\nqueued_record_wizards_count\n</li>\n<li class='column-attempt'>\ncompleted_record_wizards_count\n</li>\n<li class='column-attempt'>\nowner_routes_edit_path\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_wizards/new","name":"new","apis":[{"api_url":"/api/v1/record_wizards/new","http_method":"GET","short_description":"Build Template with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_wizards/create","name":"create","apis":[{"api_url":"/api/v1/record_wizards","http_method":"POST","short_description":"Create Template.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_wizards/show","name":"show","apis":[{"api_url":"/api/v1/record_wizards/:id","http_method":"GET","short_description":"Get Template by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_wizards/update","name":"update","apis":[{"api_url":"/api/v1/record_wizards/:id","http_method":"PUT","short_description":"Update Template by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"release_notes":{"doc_url":"/api/docs/1.0/release_notes","id":"release_notes","api_url":"/api","name":"Release Note","short_description":"API resource for managing Release Note.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/release_notes/index","name":"index","apis":[{"api_url":"/api/v1/release_notes","http_method":"GET","short_description":"List Release Note records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nrevision\n</li>\n<li class='column-attempt'>\nnotes\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\npreview_image_url\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/release_notes/new","name":"new","apis":[{"api_url":"/api/v1/release_notes/new","http_method":"GET","short_description":"Build Release Note with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/release_notes/create","name":"create","apis":[{"api_url":"/api/v1/release_notes","http_method":"POST","short_description":"Create Release Note.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/release_notes/show","name":"show","apis":[{"api_url":"/api/v1/release_notes/:id","http_method":"GET","short_description":"Get Release Note by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/release_notes/update","name":"update","apis":[{"api_url":"/api/v1/release_notes/:id","http_method":"PUT","short_description":"Update Release Note by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/release_notes/destroy","name":"destroy","apis":[{"api_url":"/api/v1/release_notes/:id","http_method":"DELETE","short_description":"Destroy Release Note by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"response_parsers":{"doc_url":"/api/docs/1.0/response_parsers","id":"response_parsers","api_url":"/api","name":"Response Parser","short_description":"API resource for managing Response Parsers.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/response_parsers/index","name":"index","apis":[{"api_url":"/api/v1/response_parsers","http_method":"GET","short_description":"List Response Parsers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\noutgoing_webhook_url_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nbuyer_conversion_id\n</li>\n<li class='column-attempt'>\nzoho_crm_command_id\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nwebhook_response_success_codes\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nvalue_path\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nvalue_formatter\n</li>\n<li class='column-attempt'>\nvalue_type\n</li>\n<li class='column-attempt'>\nvalue_expression\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/new","name":"new","apis":[{"api_url":"/api/v1/response_parsers/new","http_method":"GET","short_description":"Build Response Parser with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_url_id","full_name":"outgoing_webhook_url_id","description":"\n<p>Translation missing: en.api.response_parsers.outgoing_webhook_url_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n<p>Buyer Conversion</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n<p>Acceptable HTTP Status Codes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Token Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\n<p>Provide the path to extract a value. EG: lead.id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/create","name":"create","apis":[{"api_url":"/api/v1/response_parsers","http_method":"POST","short_description":"Create Response Parser.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_url_id","full_name":"outgoing_webhook_url_id","description":"\n<p>Translation missing: en.api.response_parsers.outgoing_webhook_url_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n<p>Buyer Conversion</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n<p>Acceptable HTTP Status Codes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Token Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\n<p>Provide the path to extract a value. EG: lead.id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/show","name":"show","apis":[{"api_url":"/api/v1/response_parsers/:id","http_method":"GET","short_description":"Get Response Parser by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/update","name":"update","apis":[{"api_url":"/api/v1/response_parsers/:id","http_method":"PUT","short_description":"Update Response Parser by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_url_id","full_name":"outgoing_webhook_url_id","description":"\n<p>Translation missing: en.api.response_parsers.outgoing_webhook_url_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n<p>Buyer Conversion</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n<p>Acceptable HTTP Status Codes</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Token Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\n<p>Provide the path to extract a value. EG: lead.id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/response_parsers/:id","http_method":"DELETE","short_description":"Destroy Response Parser by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ring_pools":{"doc_url":"/api/docs/1.0/ring_pools","id":"ring_pools","api_url":"/api","name":"Phone Number Pools","short_description":"API resource for managing Phone Number Pool.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/ring_pools/index","name":"index","apis":[{"api_url":"/api/v1/ring_pools","http_method":"GET","short_description":"List Phone Number Pools.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nnumbers_count\n</li>\n<li class='column-attempt'>\ntoll_free\n</li>\n<li class='column-attempt'>\ncountry\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nnumber_limit\n</li>\n<li class='column-attempt'>\ncampaign_registry_id\n</li>\n<li class='column-attempt'>\nnumber_stockpile\n</li>\n<li class='column-attempt'>\ntraffic_source_override_lead_traffic_source\n</li>\n<li class='column-attempt'>\nper_visitor\n</li>\n<li class='column-attempt'>\ntracking_type\n</li>\n<li class='column-attempt'>\nextensions_length\n</li>\n<li class='column-attempt'>\nextensions_minimum\n</li>\n<li class='column-attempt'>\nextensions_maximum\n</li>\n<li class='column-attempt'>\nprovider_configuration_id\n</li>\n<li class='column-attempt'>\nauto_rent_numbers\n</li>\n<li class='column-attempt'>\nis_active\n</li>\n<li class='column-attempt'>\nprovider\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/ring_pools/new","name":"new","apis":[{"api_url":"/api/v1/ring_pools/new","http_method":"GET","short_description":"Build Phone Number Pool with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Refer to the provider api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"numbers_count","full_name":"numbers_count","description":"\n<p>Numbers Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"toll_free","full_name":"toll_free","description":"\n<p>Toll Free</p>\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":[]},{"name":"country","full_name":"country","description":"\n<p>Country</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_limit","full_name":"number_limit","description":"\n<p>Number Limit</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/ring_pools/create","name":"create","apis":[{"api_url":"/api/v1/ring_pools","http_method":"POST","short_description":"Create Phone Number Pool.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Refer to the provider api for details</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"numbers_count","full_name":"numbers_count","description":"\n<p>Numbers Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"toll_free","full_name":"toll_free","description":"\n<p>Toll Free</p>\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":[]},{"name":"country","full_name":"country","description":"\n<p>Country</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_limit","full_name":"number_limit","description":"\n<p>Number Limit</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/ring_pools/show","name":"show","apis":[{"api_url":"/api/v1/ring_pools/:id","http_method":"GET","short_description":"Get Phone Number Pool by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/ring_pools/update","name":"update","apis":[{"api_url":"/api/v1/ring_pools/:id","http_method":"PUT","short_description":"Update Phone Number Pool by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n<p>Refer to the provider api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"numbers_count","full_name":"numbers_count","description":"\n<p>Numbers Count</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"toll_free","full_name":"toll_free","description":"\n<p>Toll Free</p>\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":[]},{"name":"country","full_name":"country","description":"\n<p>Country</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_limit","full_name":"number_limit","description":"\n<p>Number Limit</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/ring_pools/destroy","name":"destroy","apis":[{"api_url":"/api/v1/ring_pools/:id","http_method":"DELETE","short_description":"Destroy Phone Number Pool by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_action_groups":{"doc_url":"/api/docs/1.0/schedule_action_groups","id":"schedule_action_groups","api_url":"/api","name":"Action Group","short_description":"API resource for managing Action Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_action_groups/index","name":"index","apis":[{"api_url":"/api/v1/schedule_action_groups","http_method":"GET","short_description":"List Action Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nschedule_action_ids\n</li>\n<li class='column-attempt'>\nschedule_actions_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_action_groups/new","name":"new","apis":[{"api_url":"/api/v1/schedule_action_groups/new","http_method":"GET","short_description":"Build Action Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_action_groups/create","name":"create","apis":[{"api_url":"/api/v1/schedule_action_groups","http_method":"POST","short_description":"Create Action Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_action_groups/show","name":"show","apis":[{"api_url":"/api/v1/schedule_action_groups/:id","http_method":"GET","short_description":"Get Action Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_action_groups/update","name":"update","apis":[{"api_url":"/api/v1/schedule_action_groups/:id","http_method":"PUT","short_description":"Update Action Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_action_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_action_groups/:id","http_method":"DELETE","short_description":"Destroy Action Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_actions":{"doc_url":"/api/docs/1.0/schedule_actions","id":"schedule_actions","api_url":"/api","name":"Schedules: Actions","short_description":"Manage the actions of a schedule.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_actions/index","name":"index","apis":[{"api_url":"/api/v1/schedule_actions","http_method":"GET","short_description":"List schedule actions.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Translation missing: en.api.schedule_actions.schedule_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"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":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\n<p>Translation missing: en.api.schedule_actions.owner_relations</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>actions</code>, <code>end_of_schedule_actions</code>, <code>webhook_actions</code>, <code>call_disposition_actions</code>, <code>call_control_actions</code>, <code>key_press_flows</code>, <code>lead_retarget_actions</code>, <code>schedule_actions</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_actions/new","name":"new","apis":[{"api_url":"/api/v1/schedule_actions/new","http_method":"GET","short_description":"Build a schedule action with default attributes.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_actions/create","name":"create","apis":[{"api_url":"/api/v1/schedule_actions","http_method":"POST","short_description":"Create a schedule action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Translation missing: en.api.schedule_actions.schedule_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\n<p>Translation missing: en.api.schedule_actions.owner_relation</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>actions</code>, <code>end_of_schedule_actions</code>, <code>webhook_actions</code>, <code>call_disposition_actions</code>, <code>call_control_actions</code>, <code>key_press_flows</code>, <code>lead_retarget_actions</code>, <code>schedule_actions</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_type","full_name":"action_type","description":"\n<p>Translation missing: en.api.schedule_actions.action_type</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>dial</code>, <code>sms</code>, <code>wait</code>, <code>webhook</code>, <code>add_to_schedule</code>, <code>lead_alteration</code>, <code>zoho_crm</code>, <code>lead_block</code>, <code>lead_opt_out</code>, <code>schedule_callback</code>, <code>choice</code>, <code>restart_schedule</code>, <code>mailchimp</code>, <code>sendgrid</code>, <code>mailgun</code>, <code>infusionsoft</code>, <code>ftp_upload</code>, <code>aws_s3</code>, <code>data_append</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n<p>Translation missing: en.api.schedule_actions.token_value_map_group_ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Filter Mapping Group}[/api/docs/1.0/token_value_map_groups/index.html]. Refer to: {/api/docs/1.0/token_value_map_groups}[/api/docs/1.0/token_value_map_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_actions/show","name":"show","apis":[{"api_url":"/api/v1/schedule_actions/:id","http_method":"GET","short_description":"Get details about a schedule action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_actions/update","name":"update","apis":[{"api_url":"/api/v1/schedule_actions/:id","http_method":"PUT","short_description":"Update a schedule action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Translation missing: en.api.schedule_actions.schedule_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_actions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_actions/:id","http_method":"DELETE","short_description":"Destroy a schedule action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_agents":{"doc_url":"/api/docs/1.0/schedule_agents","id":"schedule_agents","api_url":"/api","name":"Agent Wizard","short_description":"API resource for managing Agents created via the Agent Wizard.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_agents/index","name":"index","apis":[{"api_url":"/api/v1/schedule_agents","http_method":"GET","short_description":"List Agent Wizard records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nfirst_name\n</li>\n<li class='column-attempt'>\nlast_name\n</li>\n<li class='column-attempt'>\ncompany_name\n</li>\n<li class='column-attempt'>\nemail\n</li>\n<li class='column-attempt'>\nphone_number\n</li>\n<li class='column-attempt'>\naddress_state\n</li>\n<li class='column-attempt'>\naddress_city\n</li>\n<li class='column-attempt'>\naddress_country\n</li>\n<li class='column-attempt'>\naddress_zip\n</li>\n<li class='column-attempt'>\naddress_line1\n</li>\n<li class='column-attempt'>\naddress_line2\n</li>\n<li class='column-attempt'>\ncollaborator_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\ninternal_password\n</li>\n<li class='column-attempt'>\nprofile_image_url\n</li>\n<li class='column-attempt'>\nbuyer_type\n</li>\n<li class='column-attempt'>\nagent_number\n</li>\n<li class='column-attempt'>\nnumber_id\n</li>\n<li class='column-attempt'>\nis_internal\n</li>\n<li class='column-attempt'>\ninternal_username\n</li>\n<li class='column-attempt'>\nsoftphone_sip_url\n</li>\n<li class='column-attempt'>\nsoftphone_password\n</li>\n<li class='column-attempt'>\nsoftphone_username\n</li>\n<li class='column-attempt'>\ncall_center_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_agents/new","name":"new","apis":[{"api_url":"/api/v1/schedule_agents/new","http_method":"GET","short_description":"Build Agent Wizard record with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_agents/create","name":"create","apis":[{"api_url":"/api/v1/schedule_agents","http_method":"POST","short_description":"Create Agent with Wizard.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"first_name","full_name":"first_name","description":"\n<p>First Name</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_internal","full_name":"is_internal","description":"\n<p>Internal agents only have access to your company and have a predefined password.</p>\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":[]},{"name":"buyer_type","full_name":"buyer_type","description":"\n<p>What type of Agent is this? Either quality_assurance or buyer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n<p>Email</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"internal_username","full_name":"internal_username","description":"\n<p>Username</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\n<p>Last Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"company_name","full_name":"company_name","description":"\n<p>Company Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone_number","full_name":"phone_number","description":"\n<p>Phone Number</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_state","full_name":"address_state","description":"\n<p>Address State</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_city","full_name":"address_city","description":"\n<p>Address City</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_country","full_name":"address_country","description":"\n<p>Address Country</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_zip","full_name":"address_zip","description":"\n<p>Address Zip</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_line1","full_name":"address_line1","description":"\n<p>Address Line1</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_line2","full_name":"address_line2","description":"\n<p>Address Line2</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_center_id","full_name":"call_center_id","description":"\n<p>Does this agent belong to a call center?</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Center}[/api/docs/1.0/call_centers/index.html]. Refer to: {/api/docs/1.0/call_centers}[/api/docs/1.0/call_centers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_agents/show","name":"show","apis":[{"api_url":"/api/v1/schedule_agents/:id","http_method":"GET","short_description":"Get Agent Wizard record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_agents/update","name":"update","apis":[{"api_url":"/api/v1/schedule_agents/:id","http_method":"PUT","short_description":"Update Agent Wizard record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_agents/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_agents/:id","http_method":"DELETE","short_description":"Destroy Agent Wizard record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_distributions":{"doc_url":"/api/docs/1.0/schedule_distributions","id":"schedule_distributions","api_url":"/api","name":"Schedules: Lead Distribution","short_description":"Route incoming leads to different schedules based on predefined filters. Configure filters using attributes such as geographic location, interest, lead score, or custom fields. When a new lead is received, the API evaluates these filters to automatically assign the lead to the appropriate schedule. This feature streamlines the lead distribution process, enabling quicker response times and more targeted engagement.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_distributions/index","name":"index","apis":[{"api_url":"/api/v1/schedule_distributions","http_method":"GET","short_description":"List Distribution records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\ntarget_schedule_id\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/new","name":"new","apis":[{"api_url":"/api/v1/schedule_distributions/new","http_method":"GET","short_description":"Build Distribution with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"target_schedule_id","full_name":"target_schedule_id","description":"\n<p>Target Schedule</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Translation missing: en.api.schedule_distributions.filter_group_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/create","name":"create","apis":[{"api_url":"/api/v1/schedule_distributions","http_method":"POST","short_description":"Create Distribution.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"target_schedule_id","full_name":"target_schedule_id","description":"\n<p>Target Schedule</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Translation missing: en.api.schedule_distributions.filter_group_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/show","name":"show","apis":[{"api_url":"/api/v1/schedule_distributions/:id","http_method":"GET","short_description":"Get Distribution by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/update","name":"update","apis":[{"api_url":"/api/v1/schedule_distributions/:id","http_method":"PUT","short_description":"Update Distribution by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"target_schedule_id","full_name":"target_schedule_id","description":"\n<p>Target Schedule</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n<p>Translation missing: en.api.schedule_distributions.filter_group_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_distributions/:id","http_method":"DELETE","short_description":"Destroy Distribution by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_triggers":{"doc_url":"/api/docs/1.0/schedule_triggers","id":"schedule_triggers","api_url":"/api","name":"Schedules: Triggers","short_description":"The End Of Schedule Triggers in your account. Leads will be moved to \"End Of Schedule Actions\" when any of the triggers below match.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_triggers/index","name":"index","apis":[{"api_url":"/api/v1/schedule_triggers","http_method":"GET","short_description":"Search for Schedule Triggers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule internal id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"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":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_triggers/new","name":"new","apis":[{"api_url":"/api/v1/schedule_triggers/new","http_method":"GET","short_description":"Returns a new Schedule Trigger","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule internal id</p>\n","required":true,"allow_nil":false,"allow_blank":false,"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_triggers/create","name":"create","apis":[{"api_url":"/api/v1/schedule_triggers","http_method":"POST","short_description":"Create a Schedule Trigger","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule internal id</p>\n","required":true,"allow_nil":false,"allow_blank":false,"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":[]},{"name":"name","full_name":"name","description":"\n<p>The trigger name</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_type","full_name":"trigger_type","description":"\n<p>The schedule ends when the lead has taken this action.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>none</code>, <code>tokens_match</code>, <code>expired</code>, <code>buyer_connected</code>, <code>buyer_converted</code>, <code>dial</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expire_minutes","full_name":"expire_minutes","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expire_timestamp_name","full_name":"expire_timestamp_name","description":"\n<p>Translation missing: en.api.schedule_triggers.expire_timestamp_name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>created_at</code>, <code>first_queued_at</code>, <code>first_action_at</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_triggers/show","name":"show","apis":[{"api_url":"/api/v1/schedule_triggers/:id","http_method":"GET","short_description":"Returns a Schedule Trigger by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_triggers/update","name":"update","apis":[{"api_url":"/api/v1/schedule_triggers/:id","http_method":"PUT","short_description":"Updates a Schedule Trigger by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule internal id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"name","full_name":"name","description":"\n<p>The trigger name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_type","full_name":"trigger_type","description":"\n<p>The schedule ends when the lead has taken this action.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>none</code>, <code>tokens_match</code>, <code>expired</code>, <code>buyer_connected</code>, <code>buyer_converted</code>, <code>dial</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expire_minutes","full_name":"expire_minutes","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n<p>Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:<br> <code>buyer_interest:loan,another_token:value</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_triggers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_triggers/:id","http_method":"DELETE","short_description":"Delete a Schedule Trigger by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"scheduled_callbacks":{"doc_url":"/api/docs/1.0/scheduled_callbacks","id":"scheduled_callbacks","api_url":"/api","name":"Calls: Scheduled Callbacks","short_description":"The Scheduled Callbacks in your account. Calls will be placed to leads when the callback matches.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/scheduled_callbacks/index","name":"index","apis":[{"api_url":"/api/v1/scheduled_callbacks","http_method":"GET","short_description":"List scheduled callbacks.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/scheduled_callbacks/new","name":"new","apis":[{"api_url":"/api/v1/scheduled_callbacks/new","http_method":"GET","short_description":"Returns a new Scheduled Callback","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_id","full_name":"call_id","description":"\n<p>The callback will be made against this call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_id","full_name":"lead_id","description":"\n<p>The callback will be made against this lead.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead}[/api/docs/1.0/leads/index.html]. Refer to: {/api/docs/1.0/leads}[/api/docs/1.0/leads/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/scheduled_callbacks/create","name":"create","apis":[{"api_url":"/api/v1/scheduled_callbacks","http_method":"POST","short_description":"Create a Scheduled Callback","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"to","full_name":"to","description":"\n<p>The telephone number for the consumer who will receive a callback.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>The schedule that the callback will be associated with.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"call_id","full_name":"call_id","description":"\n<p>The callback will be made against this call.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_id","full_name":"lead_id","description":"\n<p>The callback will be made against this lead.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead}[/api/docs/1.0/leads/index.html]. Refer to: {/api/docs/1.0/leads}[/api/docs/1.0/leads/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"connect_with","full_name":"connect_with","description":"\n<p>Who Should The Consumer Talk To?</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>me</code>, <code>anyone</code>, <code>connect_with_buyer_id</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"place_call_at","full_name":"place_call_at","description":"\n<p>When should the callback occur?</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"place_call_time_zone","full_name":"place_call_time_zone","description":"\n<p>The time zone that will be used when parsing place_call_at</p>\n","required":true,"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X POST \"trackdrive.com/api/v1/scheduled_callbacks?place_call_at=2024-11-28+07%3A27&place_call_time_zone=Eastern+Time+%28US+%26+Canada%29&schedule_id=12345678&to=%2B16053334444\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/scheduled_callbacks/show","name":"show","apis":[{"api_url":"/api/v1/scheduled_callbacks/:id","http_method":"GET","short_description":"Returns a Scheduled Callback by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_id","full_name":"call_id","description":"\n<p>The callback will be made against this call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_id","full_name":"lead_id","description":"\n<p>The callback will be made against this lead.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead}[/api/docs/1.0/leads/index.html]. Refer to: {/api/docs/1.0/leads}[/api/docs/1.0/leads/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/scheduled_callbacks/update","name":"update","apis":[{"api_url":"/api/v1/scheduled_callbacks/:id","http_method":"PUT","short_description":"Updates a Scheduled Callback by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"connect_with","full_name":"connect_with","description":"\n<p>Who Should The Consumer Talk To?</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>me</code>, <code>anyone</code>, <code>connect_with_buyer_id</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"place_call_at","full_name":"place_call_at","description":"\n<p>When should the callback occur?</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"place_call_time_zone","full_name":"place_call_time_zone","description":"\n<p>The time zone that will be used when parsing place_call_at</p>\n","required":true,"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/scheduled_callbacks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/scheduled_callbacks/:id","http_method":"DELETE","short_description":"Delete a Scheduled Callback by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedules":{"doc_url":"/api/docs/1.0/schedules","id":"schedules","api_url":"/api","name":"Schedules","short_description":"The schedules in your Trackdrive account. Automate placing calls, SMS, Emails, and more to leads.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedules/index","name":"index","apis":[{"api_url":"/api/v1/schedules","http_method":"GET","short_description":"List schedules.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>schedule</th><td>Default response format.</td></tr><tr><th>schedule_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/schedules?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/new","name":"new","apis":[{"api_url":"/api/v1/schedules/new","http_method":"GET","short_description":"Build a schedule with default attributes.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>schedule</th><td>Default response format.</td></tr><tr><th>schedule_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/create","name":"create","apis":[{"api_url":"/api/v1/schedules","http_method":"POST","short_description":"Create a schedule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>schedule</th><td>Default response format.</td></tr><tr><th>schedule_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/show","name":"show","apis":[{"api_url":"/api/v1/schedules/:id","http_method":"GET","short_description":"Get details about a schedule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>schedule</th><td>Default response format.</td></tr><tr><th>schedule_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/update","name":"update","apis":[{"api_url":"/api/v1/schedules/:id","http_method":"PUT","short_description":"Update a schedule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>schedule</th><td>Default response format.</td></tr><tr><th>schedule_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedules/:id","http_method":"DELETE","short_description":"Destroy a schedule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n<p>This endpoint supports multiple response formats. Pass <code>serializer=name</code> to retrieve data in an alternate format.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:<br> <div class=\"pick-list-container\"><table class=\"table table-pick-list table-condensed table-bordered table-striped\"><thead><tr><th>Acceptable Value</th><th>Description</th></tr></thead><tbody><tr><th>schedule</th><td>Default response format.</td></tr><tr><th>schedule_grid</th><td>Modern response format that returns various foreign keys for use with other API endpoints.</td></tr></tbody></table></div>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"secure_calls":{"doc_url":"/api/docs/1.0/secure_calls","id":"secure_calls","api_url":"/api","name":"Calls By Third-Party","short_description":"This resource allows third-party users to update calls using <code>td_secure_token</code> and <code>td_uuid</code> passed in a call's <strong>SIP headers</strong>. These endpoints do not require authentication with a <code>auth_token</code>","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/secure_calls/update","name":"update","apis":[{"api_url":"/api/v1/secure/:secure_token/calls/:uuid","http_method":"PUT","short_description":"Update a call with <code>td_secure_token</code> and <code>td_uuid</code> passed in a call's <strong>SIP headers</strong>.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"secure_token","full_name":"secure_token","description":"\n<p>The secure token used to authorize access to an individual object. Must be 40 characters.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression <code>/.{40}/</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n<p>A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"revenue","description":"\n<p>The revenue paid out for the call.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n<p>Did the buyer convert?</p>\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":[]},{"name":"digits","full_name":"digits","description":"\n<p>DTMF digit</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data","full_name":"data","description":"\n<p>Update the call with this data. <code>{interest: &#39;kittens&#39;, source: &#39;google&#39;, first_name: &#39;John&#39;, last_name: &#39;Smith&#39;}</code></p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -i -X PUT \"https://[your-subdomain].trackdrive.com/api/v1/secure/11111111035c9a8287c2e413a03fb32051f620e0/calls/77777777-dbe3-49ee-b28f-115ec80dcef9?revenue=10&buyer_converted=true\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/secure_calls/hang_up","name":"hang_up","apis":[{"api_url":"/api/v1/secure/:secure_token/calls/:uuid","http_method":"DELETE","short_description":"Hang up an ongoing call using a <code>td_secure_token</code> and <code>td_uuid</code> passed in a call's <strong>SIP headers</strong>.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"secure_token","full_name":"secure_token","description":"\n<p>The secure token used to authorize access to an individual object. Must be 40 characters.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression <code>/.{40}/</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n<p>A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -i -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/secure/11111111035c9a8287c2e413a03fb32051f620e0/calls/77777777-dbe3-49ee-b28f-115ec80dcef9\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/secure_calls/data","name":"data","apis":[{"api_url":"/api/v1/secure/:secure_token/calls/:uuid/data","http_method":"GET","short_description":"Returns UUID and data for the call.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"secure_token","full_name":"secure_token","description":"\n<p>The secure token used to authorize access to an individual object. Must be 40 characters.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression <code>/.{40}/</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n<p>A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -i -X GET \"https://[your-subdomain].trackdrive.com/api/v1/secure/11111111035c9a8287c2e413a03fb32051f620e0/calls/77777777-dbe3-49ee-b28f-115ec80dcef9/data\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sip_headers":{"doc_url":"/api/docs/1.0/sip_headers","id":"sip_headers","api_url":"/api","name":"Sip Header","short_description":"API resource for managing Sip Header.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sip_headers/index","name":"index","apis":[{"api_url":"/api/v1/sip_headers","http_method":"GET","short_description":"List Sip Header records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nvalue\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/new","name":"new","apis":[{"api_url":"/api/v1/sip_headers/new","http_method":"GET","short_description":"Build Sip Header with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Buyer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/create","name":"create","apis":[{"api_url":"/api/v1/sip_headers","http_method":"POST","short_description":"Create Sip Header.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Buyer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/show","name":"show","apis":[{"api_url":"/api/v1/sip_headers/:id","http_method":"GET","short_description":"Get Sip Header by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/update","name":"update","apis":[{"api_url":"/api/v1/sip_headers/:id","http_method":"PUT","short_description":"Update Sip Header by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\n<p>Buyer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sip_headers/:id","http_method":"DELETE","short_description":"Destroy Sip Header by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sms_ai_flows":{"doc_url":"/api/docs/1.0/sms_ai_flows","id":"sms_ai_flows","api_url":"/api","name":"Offers: SMS AI Flows","short_description":"API resource for managing how Incoming SMS will be handled.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sms_ai_flows/index","name":"index","apis":[{"api_url":"/api/v1/sms_ai_flows","http_method":"GET","short_description":"List SMS AI Rules records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nexternal_campaign_id\n</li>\n<li class='column-attempt'>\ndelay_lead_processing_seconds\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/new","name":"new","apis":[{"api_url":"/api/v1/sms_ai_flows/new","http_method":"GET","short_description":"Build SMS AI Rules with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>Sortable Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Filter By Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/create","name":"create","apis":[{"api_url":"/api/v1/sms_ai_flows","http_method":"POST","short_description":"Create SMS AI Rules.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_campaign_id","full_name":"external_campaign_id","description":"\n<p>External Campaign</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>Sortable Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Filter By Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/show","name":"show","apis":[{"api_url":"/api/v1/sms_ai_flows/:id","http_method":"GET","short_description":"Get SMS AI Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/update","name":"update","apis":[{"api_url":"/api/v1/sms_ai_flows/:id","http_method":"PUT","short_description":"Update SMS AI Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_campaign_id","full_name":"external_campaign_id","description":"\n<p>External Campaign</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>Sortable Order</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Filter By Traffic Source</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sms_ai_flows/:id","http_method":"DELETE","short_description":"Destroy SMS AI Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sound_files":{"doc_url":"/api/docs/1.0/sound_files","id":"sound_files","api_url":"/api","name":"Playlists: Sound Files","short_description":"API resource for managing Sound File.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sound_files/index","name":"index","apis":[{"api_url":"/api/v1/sound_files","http_method":"GET","short_description":"List Sound File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ntoken_values_count\n</li>\n<li class='column-attempt'>\nsound_playlist_ids\n</li>\n<li class='column-attempt'>\naudio_file_url\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_files/new","name":"new","apis":[{"api_url":"/api/v1/sound_files/new","http_method":"GET","short_description":"Build Sound File with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"audio_file","full_name":"audio_file","description":"\n<p>Audio File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_files/create","name":"create","apis":[{"api_url":"/api/v1/sound_files","http_method":"POST","short_description":"Create Sound File.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"audio_file","full_name":"audio_file","description":"\n<p>Audio File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_files/show","name":"show","apis":[{"api_url":"/api/v1/sound_files/:id","http_method":"GET","short_description":"Get Sound File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_files/update","name":"update","apis":[{"api_url":"/api/v1/sound_files/:id","http_method":"PUT","short_description":"Update Sound File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"audio_file","full_name":"audio_file","description":"\n<p>Audio File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_files/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sound_files/:id","http_method":"DELETE","short_description":"Destroy Sound File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sound_playlists":{"doc_url":"/api/docs/1.0/sound_playlists","id":"sound_playlists","api_url":"/api","name":"Playlists","short_description":"API resource for managing Playlist.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sound_playlists/index","name":"index","apis":[{"api_url":"/api/v1/sound_playlists","http_method":"GET","short_description":"List Playlist records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\norder_type\n</li>\n<li class='column-attempt'>\nuse_predefined_playlist\n</li>\n<li class='column-attempt'>\npredefined_playlist_id\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nsound_file_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_playlists/new","name":"new","apis":[{"api_url":"/api/v1/sound_playlists/new","http_method":"GET","short_description":"Build Playlist with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_playlists/create","name":"create","apis":[{"api_url":"/api/v1/sound_playlists","http_method":"POST","short_description":"Create Playlist.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_playlists/show","name":"show","apis":[{"api_url":"/api/v1/sound_playlists/:id","http_method":"GET","short_description":"Get Playlist by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_playlists/update","name":"update","apis":[{"api_url":"/api/v1/sound_playlists/:id","http_method":"PUT","short_description":"Update Playlist by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_playlists/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sound_playlists/:id","http_method":"DELETE","short_description":"Destroy Playlist by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"standalone_transcriptions":{"doc_url":"/api/docs/1.0/standalone_transcriptions","id":"standalone_transcriptions","api_url":"/api","name":"Standalone Transcription","short_description":"API resource for managing Standalone Transcription.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/standalone_transcriptions/index","name":"index","apis":[{"api_url":"/api/v1/standalone_transcriptions","http_method":"GET","short_description":"List Standalone Transcription records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nfile_url\n</li>\n<li class='column-attempt'>\ntranscription_flow_group_id\n</li>\n<li class='column-attempt'>\npostback_url\n</li>\n<li class='column-attempt'>\ndual_channel\n</li>\n<li class='column-attempt'>\nspeakers\n</li>\n<li class='column-attempt'>\nbody\n</li>\n<li class='column-attempt'>\nhighlight_wrapper_open\n</li>\n<li class='column-attempt'>\nhighlight_wrapper_close\n</li>\n<li class='column-attempt'>\naudio_duration\n</li>\n<li class='column-attempt'>\ntranscription_processed\n</li>\n<li class='column-attempt'>\nkeywords\n</li>\n<li class='column-attempt'>\nutterances\n</li>\n<li class='column-attempt'>\nhighlighted_utterances\n</li>\n<li class='column-attempt'>\ncaller_id\n</li>\n<li class='column-attempt'>\ndata\n</li>\n<li class='column-attempt'>\noriginal_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/standalone_transcriptions/new","name":"new","apis":[{"api_url":"/api/v1/standalone_transcriptions/new","http_method":"GET","short_description":"Build Standalone Transcription with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"file_url","full_name":"file_url","description":"\n<p>Audio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"postback_url","full_name":"postback_url","description":"\n<p>Postback URL that we will send the following JSON payload to when the transcription is complete:  id, highlighted_utterances, keywords, data, body, utterances, file_url</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id","full_name":"caller_id","description":"\n<p>Caller ID associated with the audio file, which may be used for addition triggers and actions.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dual_channel","full_name":"dual_channel","description":"\n<p>Is the audio file dual channel?</p>\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":[]},{"name":"speakers","full_name":"speakers","description":"\n<p>Number of people (speakers) in the audio file.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"highlight_wrapper_open","full_name":"highlight_wrapper_open","description":"\n<p>When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"highlight_wrapper_close","full_name":"highlight_wrapper_close","description":"\n<p>When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n<p>Transcription Flow Group that will be used to process the transcription.  This will be used even if an Offer with a Transcription Flow Group is provided.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Transcription Flow Group}[/api/docs/1.0/transcription_flow_groups/index.html]. Refer to: {/api/docs/1.0/transcription_flow_groups}[/api/docs/1.0/transcription_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer that will be used to process the transcription.  This will be used if a Transcription Flow Group is not provided,  as long as the Offer has a Transcription Flow Group.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data","full_name":"data","description":"\n<p>A JSON object that is used to store information to filter Transcription Flows and Schedule Action Groups. It is automatically updated with Trackdrive tokens (such as zip code, state, etc.).  Extra tokens can be applied to Data when specific keywords are found (Transcription Keyword  settings), or when an Action is triggered (Action Group &gt; Action settings).</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/standalone_transcriptions/create","name":"create","apis":[{"api_url":"/api/v1/standalone_transcriptions","http_method":"POST","short_description":"Create Standalone Transcription.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"file_url","full_name":"file_url","description":"\n<p>Audio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"postback_url","full_name":"postback_url","description":"\n<p>Postback URL that we will send the following JSON payload to when the transcription is complete:  id, highlighted_utterances, keywords, data, body, utterances, file_url</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caller_id","full_name":"caller_id","description":"\n<p>Caller ID associated with the audio file, which may be used for addition triggers and actions.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dual_channel","full_name":"dual_channel","description":"\n<p>Is the audio file dual channel?</p>\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":[]},{"name":"speakers","full_name":"speakers","description":"\n<p>Number of people (speakers) in the audio file.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"highlight_wrapper_open","full_name":"highlight_wrapper_open","description":"\n<p>When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"highlight_wrapper_close","full_name":"highlight_wrapper_close","description":"\n<p>When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n<p>Transcription Flow Group that will be used to process the transcription.  This will be used even if an Offer with a Transcription Flow Group is provided.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Transcription Flow Group}[/api/docs/1.0/transcription_flow_groups/index.html]. Refer to: {/api/docs/1.0/transcription_flow_groups}[/api/docs/1.0/transcription_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer that will be used to process the transcription.  This will be used if a Transcription Flow Group is not provided,  as long as the Offer has a Transcription Flow Group.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data","full_name":"data","description":"\n<p>A JSON object that is used to store information to filter Transcription Flows and Schedule Action Groups. It is automatically updated with Trackdrive tokens (such as zip code, state, etc.).  Extra tokens can be applied to Data when specific keywords are found (Transcription Keyword  settings), or when an Action is triggered (Action Group &gt; Action settings).</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["# Submit standalone transcriptions as JSON:\ncurl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \\\n     -H \"Content-Type: application/json\" \\\n     -X POST \\\n     -d '{\"caller_id\":\"+18004506787\",\"file_url\":\"http://example.com/publicly_accessible_file.mp3\",\"postback_url\":\"http://example.com/postback_url_without_authentication\",\"data\":{\"loan_amount\":\"501\",\"custom_token\":\"the_value\"}}' \\\n     \"https://[your-subdomain].trackdrive.com/api/v1/standalone_transcriptions\"\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/standalone_transcriptions/show","name":"show","apis":[{"api_url":"/api/v1/standalone_transcriptions/:id","http_method":"GET","short_description":"Get Standalone Transcription by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_id","full_name":"caller_id","description":"\n<p>Caller ID associated with the audio file, which may be used for addition triggers and actions.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dual_channel","full_name":"dual_channel","description":"\n<p>Is the audio file dual channel?</p>\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":[]},{"name":"speakers","full_name":"speakers","description":"\n<p>Number of people (speakers) in the audio file.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"highlight_wrapper_open","full_name":"highlight_wrapper_open","description":"\n<p>When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"highlight_wrapper_close","full_name":"highlight_wrapper_close","description":"\n<p>When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n<p>Transcription Flow Group that will be used to process the transcription.  This will be used even if an Offer with a Transcription Flow Group is provided.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Transcription Flow Group}[/api/docs/1.0/transcription_flow_groups/index.html]. Refer to: {/api/docs/1.0/transcription_flow_groups}[/api/docs/1.0/transcription_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer that will be used to process the transcription.  This will be used if a Transcription Flow Group is not provided,  as long as the Offer has a Transcription Flow Group.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data","full_name":"data","description":"\n<p>A JSON object that is used to store information to filter Transcription Flows and Schedule Action Groups. It is automatically updated with Trackdrive tokens (such as zip code, state, etc.).  Extra tokens can be applied to Data when specific keywords are found (Transcription Keyword  settings), or when an Action is triggered (Action Group &gt; Action settings).</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"original_data","full_name":"original_data","description":"\n<p>The original data that was provided when the transcription record was created.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"keywords","full_name":"keywords","description":"\n<p>Keywords that were found in the audio file.</p>\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":[]},{"name":"utterances","full_name":"utterances","description":"\n<p>Utterances are the spoken words in the audio file, broken down by speaker.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"highlighted_utterances","full_name":"highlighted_utterances","description":"\n<p>Highlighted Utterances are the spoken words in the audio file,  broken down by speaker, with keywords highlighted.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"transcription_processed","full_name":"transcription_processed","description":"\n<p>Returns true if the audio file has been transcribed and keywords have been highlighted.</p>\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":[]},{"name":"audio_duration","full_name":"audio_duration","description":"\n<p>The detected duration of the audio file in seconds.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"body","full_name":"body","description":"\n<p>The raw transcription text of the audio file.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/standalone_transcriptions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/standalone_transcriptions/:id","http_method":"DELETE","short_description":"Destroy Standalone Transcription by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"state_business_hours":{"doc_url":"/api/docs/1.0/state_business_hours","id":"state_business_hours","api_url":"/api","name":"State Call Time","short_description":"API resource for managing State Call Time.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/state_business_hours/index","name":"index","apis":[{"api_url":"/api/v1/state_business_hours","http_method":"GET","short_description":"List State Call Time records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nstates\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nmonday_open_at\n</li>\n<li class='column-attempt'>\nmonday_close_at\n</li>\n<li class='column-attempt'>\ntuesday_open_at\n</li>\n<li class='column-attempt'>\ntuesday_close_at\n</li>\n<li class='column-attempt'>\nwednesday_open_at\n</li>\n<li class='column-attempt'>\nwednesday_close_at\n</li>\n<li class='column-attempt'>\nthursday_open_at\n</li>\n<li class='column-attempt'>\nthursday_close_at\n</li>\n<li class='column-attempt'>\nfriday_open_at\n</li>\n<li class='column-attempt'>\nfriday_close_at\n</li>\n<li class='column-attempt'>\nsaturday_open_at\n</li>\n<li class='column-attempt'>\nsaturday_close_at\n</li>\n<li class='column-attempt'>\nsunday_open_at\n</li>\n<li class='column-attempt'>\nmonday_closed\n</li>\n<li class='column-attempt'>\ntuesday_closed\n</li>\n<li class='column-attempt'>\nwednesday_closed\n</li>\n<li class='column-attempt'>\nthursday_closed\n</li>\n<li class='column-attempt'>\nfriday_closed\n</li>\n<li class='column-attempt'>\nsaturday_closed\n</li>\n<li class='column-attempt'>\nsunday_closed\n</li>\n<li class='column-attempt'>\nsunday_close_at\n</li>\n<li class='column-attempt'>\ntemplate_description\n</li>\n<li class='column-attempt'>\ntemplate_tier\n</li>\n<li class='column-attempt'>\ntemplate_enabled\n</li>\n<li class='column-attempt'>\ntemplate_copy_on_company_create\n</li>\n<li class='column-attempt'>\ntemplate_id\n</li>\n<li class='column-attempt'>\nis_system_template\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/new","name":"new","apis":[{"api_url":"/api/v1/state_business_hours/new","http_method":"GET","short_description":"Build State Call Time with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"monday_open_at","full_name":"monday_open_at","description":"\n<p>Monday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"monday_close_at","full_name":"monday_close_at","description":"\n<p>Monday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tuesday_open_at","full_name":"tuesday_open_at","description":"\n<p>Tuesday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tuesday_close_at","full_name":"tuesday_close_at","description":"\n<p>Tuesday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wednesday_open_at","full_name":"wednesday_open_at","description":"\n<p>Wednesday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wednesday_close_at","full_name":"wednesday_close_at","description":"\n<p>Wednesday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thursday_open_at","full_name":"thursday_open_at","description":"\n<p>Thursday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thursday_close_at","full_name":"thursday_close_at","description":"\n<p>Thursday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"friday_open_at","full_name":"friday_open_at","description":"\n<p>Friday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"friday_close_at","full_name":"friday_close_at","description":"\n<p>Friday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"saturday_open_at","full_name":"saturday_open_at","description":"\n<p>Saturday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"saturday_close_at","full_name":"saturday_close_at","description":"\n<p>Saturday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sunday_open_at","full_name":"sunday_open_at","description":"\n<p>Sunday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sunday_close_at","full_name":"sunday_close_at","description":"\n<p>Sunday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/create","name":"create","apis":[{"api_url":"/api/v1/state_business_hours","http_method":"POST","short_description":"Create State Call Time.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"monday_open_at","full_name":"monday_open_at","description":"\n<p>Monday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"monday_close_at","full_name":"monday_close_at","description":"\n<p>Monday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tuesday_open_at","full_name":"tuesday_open_at","description":"\n<p>Tuesday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tuesday_close_at","full_name":"tuesday_close_at","description":"\n<p>Tuesday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wednesday_open_at","full_name":"wednesday_open_at","description":"\n<p>Wednesday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wednesday_close_at","full_name":"wednesday_close_at","description":"\n<p>Wednesday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thursday_open_at","full_name":"thursday_open_at","description":"\n<p>Thursday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thursday_close_at","full_name":"thursday_close_at","description":"\n<p>Thursday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"friday_open_at","full_name":"friday_open_at","description":"\n<p>Friday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"friday_close_at","full_name":"friday_close_at","description":"\n<p>Friday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"saturday_open_at","full_name":"saturday_open_at","description":"\n<p>Saturday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"saturday_close_at","full_name":"saturday_close_at","description":"\n<p>Saturday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sunday_open_at","full_name":"sunday_open_at","description":"\n<p>Sunday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sunday_close_at","full_name":"sunday_close_at","description":"\n<p>Sunday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/show","name":"show","apis":[{"api_url":"/api/v1/state_business_hours/:id","http_method":"GET","short_description":"Get State Call Time by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/update","name":"update","apis":[{"api_url":"/api/v1/state_business_hours/:id","http_method":"PUT","short_description":"Update State Call Time by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"monday_open_at","full_name":"monday_open_at","description":"\n<p>Monday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"monday_close_at","full_name":"monday_close_at","description":"\n<p>Monday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tuesday_open_at","full_name":"tuesday_open_at","description":"\n<p>Tuesday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tuesday_close_at","full_name":"tuesday_close_at","description":"\n<p>Tuesday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wednesday_open_at","full_name":"wednesday_open_at","description":"\n<p>Wednesday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wednesday_close_at","full_name":"wednesday_close_at","description":"\n<p>Wednesday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thursday_open_at","full_name":"thursday_open_at","description":"\n<p>Thursday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thursday_close_at","full_name":"thursday_close_at","description":"\n<p>Thursday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"friday_open_at","full_name":"friday_open_at","description":"\n<p>Friday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"friday_close_at","full_name":"friday_close_at","description":"\n<p>Friday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"saturday_open_at","full_name":"saturday_open_at","description":"\n<p>Saturday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"saturday_close_at","full_name":"saturday_close_at","description":"\n<p>Saturday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sunday_open_at","full_name":"sunday_open_at","description":"\n<p>Sunday Open At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sunday_close_at","full_name":"sunday_close_at","description":"\n<p>Sunday Close At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/destroy","name":"destroy","apis":[{"api_url":"/api/v1/state_business_hours/:id","http_method":"DELETE","short_description":"Destroy State Call Time by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"state_call_limits":{"doc_url":"/api/docs/1.0/state_call_limits","id":"state_call_limits","api_url":"/api","name":"State Call Frequency","short_description":"API resource for managing State Call Frequency.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/state_call_limits/index","name":"index","apis":[{"api_url":"/api/v1/state_call_limits","http_method":"GET","short_description":"List State Call Frequency records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nstates\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncall_limit_interval\n</li>\n<li class='column-attempt'>\ncall_limit_limit\n</li>\n<li class='column-attempt'>\nis_system_template\n</li>\n<li class='column-attempt'>\ntemplate_description\n</li>\n<li class='column-attempt'>\ntemplate_tier\n</li>\n<li class='column-attempt'>\ntemplate_enabled\n</li>\n<li class='column-attempt'>\ntemplate_copy_on_company_create\n</li>\n<li class='column-attempt'>\ntemplate_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/new","name":"new","apis":[{"api_url":"/api/v1/state_call_limits/new","http_method":"GET","short_description":"Build State Call Frequency with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_limit_interval","full_name":"call_limit_interval","description":"\n<p>Call Limit Interval</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_limit_limit","full_name":"call_limit_limit","description":"\n<p>Call Limit Limit</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/create","name":"create","apis":[{"api_url":"/api/v1/state_call_limits","http_method":"POST","short_description":"Create State Call Frequency.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_limit_interval","full_name":"call_limit_interval","description":"\n<p>Call Limit Interval</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_limit_limit","full_name":"call_limit_limit","description":"\n<p>Call Limit Limit</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/show","name":"show","apis":[{"api_url":"/api/v1/state_call_limits/:id","http_method":"GET","short_description":"Get State Call Frequency by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/update","name":"update","apis":[{"api_url":"/api/v1/state_call_limits/:id","http_method":"PUT","short_description":"Update State Call Frequency by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_limit_interval","full_name":"call_limit_interval","description":"\n<p>Call Limit Interval</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_limit_limit","full_name":"call_limit_limit","description":"\n<p>Call Limit Limit</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/destroy","name":"destroy","apis":[{"api_url":"/api/v1/state_call_limits/:id","http_method":"DELETE","short_description":"Destroy State Call Frequency by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"state_holidays":{"doc_url":"/api/docs/1.0/state_holidays","id":"state_holidays","api_url":"/api","name":"State Holiday","short_description":"API resource for managing State Holiday.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/state_holidays/index","name":"index","apis":[{"api_url":"/api/v1/state_holidays","http_method":"GET","short_description":"List State Holiday records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nstates\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nholiday_dates\n</li>\n<li class='column-attempt'>\ntemplate_description\n</li>\n<li class='column-attempt'>\ntemplate_tier\n</li>\n<li class='column-attempt'>\ntemplate_enabled\n</li>\n<li class='column-attempt'>\ntemplate_copy_on_company_create\n</li>\n<li class='column-attempt'>\ntemplate_id\n</li>\n<li class='column-attempt'>\nis_system_template\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_holidays/new","name":"new","apis":[{"api_url":"/api/v1/state_holidays/new","http_method":"GET","short_description":"Build State Holiday with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"holiday_dates","full_name":"holiday_dates","description":"\n<p>Holiday Dates</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_holidays/create","name":"create","apis":[{"api_url":"/api/v1/state_holidays","http_method":"POST","short_description":"Create State Holiday.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"holiday_dates","full_name":"holiday_dates","description":"\n<p>Holiday Dates</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_holidays/show","name":"show","apis":[{"api_url":"/api/v1/state_holidays/:id","http_method":"GET","short_description":"Get State Holiday by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_holidays/update","name":"update","apis":[{"api_url":"/api/v1/state_holidays/:id","http_method":"PUT","short_description":"Update State Holiday by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\n<p>States</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"holiday_dates","full_name":"holiday_dates","description":"\n<p>Holiday Dates</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_holidays/destroy","name":"destroy","apis":[{"api_url":"/api/v1/state_holidays/:id","http_method":"DELETE","short_description":"Destroy State Holiday by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"state_rule_groups":{"doc_url":"/api/docs/1.0/state_rule_groups","id":"state_rule_groups","api_url":"/api","name":"State Call Rules","short_description":"API resource for managing State Call Rules.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/state_rule_groups/index","name":"index","apis":[{"api_url":"/api/v1/state_rule_groups","http_method":"GET","short_description":"List State Call Rules records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nrule_scope\n</li>\n<li class='column-attempt'>\noffer_ids\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nstate_business_hour_ids\n</li>\n<li class='column-attempt'>\nstate_call_limit_ids\n</li>\n<li class='column-attempt'>\nstate_holiday_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_rule_groups/new","name":"new","apis":[{"api_url":"/api/v1/state_rule_groups/new","http_method":"GET","short_description":"Build State Call Rules with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"rule_scope","full_name":"rule_scope","description":"\n<p>Rule Scope</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>company</code>, <code>offer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_ids","full_name":"offer_ids","description":"\n<p>Offer Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_business_hour_ids","full_name":"state_business_hour_ids","description":"\n<p>State Business Hour Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\n<p>State Call Limit Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\n<p>State Holidays Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_rule_groups/create","name":"create","apis":[{"api_url":"/api/v1/state_rule_groups","http_method":"POST","short_description":"Create State Call Rules.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"rule_scope","full_name":"rule_scope","description":"\n<p>Rule Scope</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>company</code>, <code>offer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_ids","full_name":"offer_ids","description":"\n<p>Offer Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_business_hour_ids","full_name":"state_business_hour_ids","description":"\n<p>State Business Hour Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\n<p>State Call Limit Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\n<p>State Holidays Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_rule_groups/show","name":"show","apis":[{"api_url":"/api/v1/state_rule_groups/:id","http_method":"GET","short_description":"Get State Call Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_rule_groups/update","name":"update","apis":[{"api_url":"/api/v1/state_rule_groups/:id","http_method":"PUT","short_description":"Update State Call Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"rule_scope","full_name":"rule_scope","description":"\n<p>Rule Scope</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>company</code>, <code>offer</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_ids","full_name":"offer_ids","description":"\n<p>Offer Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_business_hour_ids","full_name":"state_business_hour_ids","description":"\n<p>State Business Hour Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\n<p>State Call Limit Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\n<p>State Holidays Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_rule_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/state_rule_groups/:id","http_method":"DELETE","short_description":"Destroy State Call Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"subscriptions":{"doc_url":"/api/docs/1.0/subscriptions","id":"subscriptions","api_url":"/api","name":"Webhook Subscriptions","short_description":"Subscribe to events and then wait for Trackdrive to deliver the payload when things happen. The gist is: you POST a subscription to /api/v1/subscription/ requesting to receive hooks at some target URL. Every time the event happens, Trackdrive pings you at the target URL with the payload.\n","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/subscriptions/index","name":"index","apis":[{"api_url":"/api/v1/subscriptions","http_method":"GET","short_description":"List Subscriptions","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/subscriptions?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/new","name":"new","apis":[{"api_url":"/api/v1/webhook_subscriptions/new","http_method":"GET","short_description":"Build Webhook Subscription with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/create","name":"create","apis":[{"api_url":"/api/v1/subscriptions","http_method":"POST","short_description":"Create a subscription","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"target_url","full_name":"target_url","description":"\n<p>The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid URL.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"event","full_name":"event","description":"\n<p>The event that will be triggered. EG: When a new call comes in.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>new_call</code>, <code>call_ringing</code>, <code>call_forwarded</code>, <code>call_ended</code>, <code>call_changed</code>, <code>new_lead</code>, <code>lead_ended</code>, <code>lead_converted</code>, <code>lead_opted_out</code>, <code>lead_changed</code>, <code>incoming_text_message</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trigger_fields","full_name":"trigger_fields","description":"\n<p>Filter the data returned by the subscription. Only trigger if the object matches the given trigger fields. For example:<br> <code>{buyer_converted: true, offer_id: 1}</code> would only fire the trigger if the call converted and came from offer 1. Acceptable triggers: <code>schedule_id</code> <code>traffic_source_id</code> <code>offer_id</code> <code>buyer_converted</code> <code>has_recording</code> <code>either_converted</code> <code>buyer_id</code> <code>offer_converted</code> <code>number_id</code></p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"target_url\": \"https://hooks.zapier.com/<unique_path>\", \"event\": \"new_call\"}' https://[your-subdomain].trackdrive.com/api/v1/subscriptions"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/show","name":"show","apis":[{"api_url":"/api/v1/subscriptions/:id","http_method":"GET","short_description":"Get a subscription","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/subscriptions/123456789\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/update","name":"update","apis":[{"api_url":"/api/v1/subscriptions/:id","http_method":"PUT","short_description":"Update a subscription","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"target_url","full_name":"target_url","description":"\n<p>The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid URL.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"event","full_name":"event","description":"\n<p>The event that will be triggered. EG: When a new call comes in.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>new_call</code>, <code>call_ringing</code>, <code>call_forwarded</code>, <code>call_ended</code>, <code>call_changed</code>, <code>new_lead</code>, <code>lead_ended</code>, <code>lead_converted</code>, <code>lead_opted_out</code>, <code>lead_changed</code>, <code>incoming_text_message</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"target_url\": \"https://hooks.zapier.com/<unique_path>\", \"event\": \"new_call\"}' https://[your-subdomain].trackdrive.com/api/v1/subscriptions/123456789"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/subscriptions/:id","http_method":"DELETE","short_description":"Delete a subscription","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE https://[your-subdomain].trackdrive.com/api/v1/subscriptions/123456789"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/destroy_target_url","name":"destroy_target_url","apis":[{"api_url":"/api/v1/subscriptions","http_method":"DELETE","short_description":"Delete a subscription matching a target_url","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"target_url","full_name":"target_url","description":"\n<p>The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE  -d '{\"target_url\": \"https://hooks.zapier.com/<unique_path>\"}' https://[your-subdomain].trackdrive.com/api/v1/subscriptions"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sunspot_indexers":{"doc_url":"/api/docs/1.0/sunspot_indexers","id":"sunspot_indexers","api_url":"/api","name":"Sunspot Indexer","short_description":"API resource for managing Sunspot Indexer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sunspot_indexers/index","name":"index","apis":[{"api_url":"/api/v1/sunspot_indexers","http_method":"GET","short_description":"List Sunspot Indexer records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nactive\n</li>\n<li class='column-attempt'>\nrails_model_name\n</li>\n<li class='column-attempt'>\ncounter\n</li>\n<li class='column-attempt'>\nlast_id\n</li>\n<li class='column-attempt'>\nlast_created_at\n</li>\n<li class='column-attempt'>\ntarget_instances\n</li>\n<li class='column-attempt'>\ntarget_company_ids\n</li>\n<li class='column-attempt'>\nrun_before_solr_index\n</li>\n<li class='column-attempt'>\nreindex_banned_companies\n</li>\n<li class='column-attempt'>\nlimit_value\n</li>\n<li class='column-attempt'>\nslice_value\n</li>\n<li class='column-attempt'>\nbusiness_hours_open\n</li>\n<li class='column-attempt'>\nopen_now\n</li>\n<li class='column-attempt'>\nbusiness_hours_close\n</li>\n<li class='column-attempt'>\ntime_zone\n</li>\n<li class='column-attempt'>\njob_type\n</li>\n<li class='column-attempt'>\nstop_index_at\n</li>\n<li class='column-attempt'>\nstart_index_at\n</li>\n<li class='column-attempt'>\nswap_target_instances_on_complete\n</li>\n<li class='column-attempt'>\nreindex_records_after_job_created\n</li>\n<li class='column-attempt'>\nstop_index_after_seconds\n</li>\n<li class='column-attempt'>\npreview_target_company_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sunspot_indexers/new","name":"new","apis":[{"api_url":"/api/v1/sunspot_indexers/new","http_method":"GET","short_description":"Build Sunspot Indexer with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sunspot_indexers/create","name":"create","apis":[{"api_url":"/api/v1/sunspot_indexers","http_method":"POST","short_description":"Create Sunspot Indexer.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sunspot_indexers/show","name":"show","apis":[{"api_url":"/api/v1/sunspot_indexers/:id","http_method":"GET","short_description":"Get Sunspot Indexer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sunspot_indexers/update","name":"update","apis":[{"api_url":"/api/v1/sunspot_indexers/:id","http_method":"PUT","short_description":"Update Sunspot Indexer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sunspot_indexers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sunspot_indexers/:id","http_method":"DELETE","short_description":"Destroy Sunspot Indexer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tcr_brands":{"doc_url":"/api/docs/1.0/tcr_brands","id":"tcr_brands","api_url":"/api","name":"TCR Brand","short_description":"API resource for managing TCR Brand.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/tcr_brands/index","name":"index","apis":[{"api_url":"/api/v1/tcr_brands","http_method":"GET","short_description":"List TCR Brand records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ndisplay_name\n</li>\n<li class='column-attempt'>\nphone\n</li>\n<li class='column-attempt'>\nstreet\n</li>\n<li class='column-attempt'>\ncity\n</li>\n<li class='column-attempt'>\nstate\n</li>\n<li class='column-attempt'>\npostal_code\n</li>\n<li class='column-attempt'>\ncountry\n</li>\n<li class='column-attempt'>\nemail\n</li>\n<li class='column-attempt'>\nbrand_id\n</li>\n<li class='column-attempt'>\nentity_type\n</li>\n<li class='column-attempt'>\ncsp_id\n</li>\n<li class='column-attempt'>\ncompany_name\n</li>\n<li class='column-attempt'>\nein\n</li>\n<li class='column-attempt'>\nein_issuing_country\n</li>\n<li class='column-attempt'>\nwebsite\n</li>\n<li class='column-attempt'>\nbrand_relationship\n</li>\n<li class='column-attempt'>\nvertical\n</li>\n<li class='column-attempt'>\nuniversal_ein\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_brands/new","name":"new","apis":[{"api_url":"/api/v1/tcr_brands/new","http_method":"GET","short_description":"Build TCR Brand with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_brands/create","name":"create","apis":[{"api_url":"/api/v1/tcr_brands","http_method":"POST","short_description":"Create TCR Brand.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_brands/show","name":"show","apis":[{"api_url":"/api/v1/tcr_brands/:id","http_method":"GET","short_description":"Get TCR Brand by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_brands/update","name":"update","apis":[{"api_url":"/api/v1/tcr_brands/:id","http_method":"PUT","short_description":"Update TCR Brand by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tcr_campaigns":{"doc_url":"/api/docs/1.0/tcr_campaigns","id":"tcr_campaigns","api_url":"/api","name":"TCR Campaign","short_description":"API resource for managing TCR Campaign.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/tcr_campaigns/index","name":"index","apis":[{"api_url":"/api/v1/tcr_campaigns","http_method":"GET","short_description":"List TCR Campaign records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ntcr_brand_id\n</li>\n<li class='column-attempt'>\ncampaign_id\n</li>\n<li class='column-attempt'>\ncsp_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\ncreate_date\n</li>\n<li class='column-attempt'>\nauto_renewal\n</li>\n<li class='column-attempt'>\nbilled_date\n</li>\n<li class='column-attempt'>\nbrand_id\n</li>\n<li class='column-attempt'>\nvertical\n</li>\n<li class='column-attempt'>\nusecase\n</li>\n<li class='column-attempt'>\nsub_usecases\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nembedded_link\n</li>\n<li class='column-attempt'>\nembedded_phone\n</li>\n<li class='column-attempt'>\naffiliate_marketing\n</li>\n<li class='column-attempt'>\nnumber_pool\n</li>\n<li class='column-attempt'>\nage_gated\n</li>\n<li class='column-attempt'>\ndirect_lending\n</li>\n<li class='column-attempt'>\nsubscriber_optin\n</li>\n<li class='column-attempt'>\nsubscriber_optout\n</li>\n<li class='column-attempt'>\nsubscriber_help\n</li>\n<li class='column-attempt'>\nsample1\n</li>\n<li class='column-attempt'>\nsample2\n</li>\n<li class='column-attempt'>\nsample3\n</li>\n<li class='column-attempt'>\nsample4\n</li>\n<li class='column-attempt'>\nsample5\n</li>\n<li class='column-attempt'>\nmessage_flow\n</li>\n<li class='column-attempt'>\nhelp_message\n</li>\n<li class='column-attempt'>\nreference_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_campaigns/new","name":"new","apis":[{"api_url":"/api/v1/tcr_campaigns/new","http_method":"GET","short_description":"Build TCR Campaign with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_campaigns/create","name":"create","apis":[{"api_url":"/api/v1/tcr_campaigns","http_method":"POST","short_description":"Create TCR Campaign.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_campaigns/show","name":"show","apis":[{"api_url":"/api/v1/tcr_campaigns/:id","http_method":"GET","short_description":"Get TCR Campaign by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_campaigns/update","name":"update","apis":[{"api_url":"/api/v1/tcr_campaigns/:id","http_method":"PUT","short_description":"Update TCR Campaign by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tcr_campaigns/destroy","name":"destroy","apis":[{"api_url":"/api/v1/tcr_campaigns/:id","http_method":"DELETE","short_description":"Destroy TCR Campaign by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"td_ec2_instances":{"doc_url":"/api/docs/1.0/td_ec2_instances","id":"td_ec2_instances","api_url":"/api","name":"EC2 Instance","short_description":"API resource for managing EC2 Instance.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/td_ec2_instances/index","name":"index","apis":[{"api_url":"/api/v1/td_ec2_instances","http_method":"GET","short_description":"List EC2 Instance records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nshutdown_at\n</li>\n<li class='column-attempt'>\ndeploy_started_at\n</li>\n<li class='column-attempt'>\ndeploy_finished_at\n</li>\n<li class='column-attempt'>\ndeploy_failed_at\n</li>\n<li class='column-attempt'>\nlast_deployed_at\n</li>\n<li class='column-attempt'>\nsidekiq_quiet_at\n</li>\n<li class='column-attempt'>\nload_balancer_enabled\n</li>\n<li class='column-attempt'>\ngit_commit\n</li>\n<li class='column-attempt'>\npassenger_process_count\n</li>\n<li class='column-attempt'>\nsidekiq_process_count\n</li>\n<li class='column-attempt'>\nregistered_with_envoy\n</li>\n<li class='column-attempt'>\ncpu_60\n</li>\n<li class='column-attempt'>\ncpu_15\n</li>\n<li class='column-attempt'>\ncpu_5\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nserver_role\n</li>\n<li class='column-attempt'>\nserver_category\n</li>\n<li class='column-attempt'>\nstate\n</li>\n<li class='column-attempt'>\ninstance_type\n</li>\n<li class='column-attempt'>\nip\n</li>\n<li class='column-attempt'>\nprivate_ip\n</li>\n<li class='column-attempt'>\navailability_zone\n</li>\n<li class='column-attempt'>\ntags_list\n</li>\n<li class='column-attempt'>\nfreeswitch_amqp\n</li>\n<li class='column-attempt'>\nfreeswitch_outbound_trunk\n</li>\n<li class='column-attempt'>\nfreeswitch_khomp_trunk\n</li>\n<li class='column-attempt'>\nfreeswitch_acl_any_ip\n</li>\n<li class='column-attempt'>\nzookeeper_cluster_id\n</li>\n<li class='column-attempt'>\nimage_id\n</li>\n<li class='column-attempt'>\nssh_user\n</li>\n<li class='column-attempt'>\nsolrcloud_cluster_id\n</li>\n<li class='column-attempt'>\nerrors_count_10\n</li>\n<li class='column-attempt'>\nerrors_count_60\n</li>\n<li class='column-attempt'>\nfreeswitch_max_sessions\n</li>\n<li class='column-attempt'>\nfreeswitch_sps\n</li>\n<li class='column-attempt'>\nfreeswitch_inbound_trunk\n</li>\n<li class='column-attempt'>\nlsb_release\n</li>\n<li class='column-attempt'>\ncpu_604800\n</li>\n<li class='column-attempt'>\ncpu_86400\n</li>\n<li class='column-attempt'>\nfreeswitch_xml_curl_dialplan\n</li>\n<li class='column-attempt'>\nfreeswitch_xml_curl_endpoint\n</li>\n<li class='column-attempt'>\nfreeswitch_xml_curl_call_routing\n</li>\n<li class='column-attempt'>\nfreeswitch_hostname\n</li>\n<li class='column-attempt'>\nswitchlio_health_check\n</li>\n<li class='column-attempt'>\nswitchlio_load_balancer_enabled\n</li>\n<li class='column-attempt'>\nfreeswitch_mod_com_amd_enabled\n</li>\n<li class='column-attempt'>\ncss_status\n</li>\n<li class='column-attempt'>\nhuman_status\n</li>\n<li class='column-attempt'>\ndeploy_duration\n</li>\n<li class='column-attempt'>\nrsolr_query_average\n</li>\n<li class='column-attempt'>\nrsolr_errors_count\n</li>\n<li class='column-attempt'>\nserver_role_background_color\n</li>\n<li class='column-attempt'>\nserver_role_text_color\n</li>\n<li class='column-attempt'>\nserver_role_icon\n</li>\n<li class='column-attempt'>\ngit_commit_color\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/td_ec2_instances/show","name":"show","apis":[{"api_url":"/api/v1/td_ec2_instances/:id","http_method":"GET","short_description":"Get EC2 Instance by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/td_ec2_instances/update","name":"update","apis":[{"api_url":"/api/v1/td_ec2_instances/:id","http_method":"PUT","short_description":"Update EC2 Instance by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/td_ec2_instances/destroy","name":"destroy","apis":[{"api_url":"/api/v1/td_ec2_instances/:id","http_method":"DELETE","short_description":"Translation missing: en.api.td_ec2_instances.delete","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"text_message_flows":{"doc_url":"/api/docs/1.0/text_message_flows","id":"text_message_flows","api_url":"/api","name":"SMS Flow","short_description":"API resource for managing SMS Flow.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/text_message_flows/index","name":"index","apis":[{"api_url":"/api/v1/text_message_flows","http_method":"GET","short_description":"List SMS Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ntemplate_description\n</li>\n<li class='column-attempt'>\ntemplate_enabled\n</li>\n<li class='column-attempt'>\ntemplate_tier\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nparse_value_with_expression\n</li>\n<li class='column-attempt'>\nvalue_formatter\n</li>\n<li class='column-attempt'>\nvalue_expression\n</li>\n<li class='column-attempt'>\nuse_flow_when_pattern_matches\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\ntoken_value_ids\n</li>\n<li class='column-attempt'>\nrequest_a_response\n</li>\n<li class='column-attempt'>\nresponse_message\n</li>\n<li class='column-attempt'>\ncontact_field_assign_id\n</li>\n<li class='column-attempt'>\ncontact_field_validate_id\n</li>\n<li class='column-attempt'>\ntext_message_flow_id\n</li>\n<li class='column-attempt'>\nassert_acceptable_with_contact_field\n</li>\n<li class='column-attempt'>\nresponse_message_when_unacceptable\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nattribution_token_value_ids\n</li>\n<li class='column-attempt'>\noutgoing_webhook_ids\n</li>\n<li class='column-attempt'>\ntext_message_flows_count\n</li>\n<li class='column-attempt'>\nprocess_response_with_sms_flow_type\n</li>\n<li class='column-attempt'>\nwait_for_response_seconds\n</li>\n<li class='column-attempt'>\nvalid_responses_csv\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/new","name":"new","apis":[{"api_url":"/api/v1/text_message_flows/new","http_method":"GET","short_description":"Build SMS Flow with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\n<p>Parse Value With Expression</p>\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":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Value Formatter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\n<p>Value Expression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\n<p>Use Flow When Pattern Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"request_a_response","full_name":"request_a_response","description":"\n<p>Request A Response</p>\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":[]},{"name":"key","full_name":"key","description":"\n<p>Translation missing: en.api.text_message_flows.key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\n<p>Assert Acceptable With Contact Field</p>\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":[]},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\n<p>Response Message When Unacceptable</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/create","name":"create","apis":[{"api_url":"/api/v1/text_message_flows","http_method":"POST","short_description":"Create SMS Flow.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\n<p>Parse Value With Expression</p>\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":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Value Formatter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\n<p>Value Expression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\n<p>Use Flow When Pattern Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"request_a_response","full_name":"request_a_response","description":"\n<p>Request A Response</p>\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":[]},{"name":"key","full_name":"key","description":"\n<p>Translation missing: en.api.text_message_flows.key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\n<p>Assert Acceptable With Contact Field</p>\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":[]},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\n<p>Response Message When Unacceptable</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/show","name":"show","apis":[{"api_url":"/api/v1/text_message_flows/:id","http_method":"GET","short_description":"Get SMS Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/update","name":"update","apis":[{"api_url":"/api/v1/text_message_flows/:id","http_method":"PUT","short_description":"Update SMS Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Offer</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\n<p>Parse Value With Expression</p>\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":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Value Formatter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\n<p>Value Expression</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\n<p>Use Flow When Pattern Matches</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"request_a_response","full_name":"request_a_response","description":"\n<p>Request A Response</p>\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":[]},{"name":"key","full_name":"key","description":"\n<p>Translation missing: en.api.text_message_flows.key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\n<p>Assert Acceptable With Contact Field</p>\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":[]},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\n<p>Response Message When Unacceptable</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/text_message_flows/:id","http_method":"DELETE","short_description":"Destroy SMS Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"text_messages":{"doc_url":"/api/docs/1.0/text_messages","id":"text_messages","api_url":"/api","name":"SMS: Outgoing Text Messages","short_description":"Sends a message by submitting an outbound message request.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/text_messages/create","name":"create","apis":[{"api_url":"/api/v1/text_messages","http_method":"POST","short_description":"Sends a message by submitting an outbound message request.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"from","full_name":"from","description":"\n<p>Sending address (+E.164 formatted phone number.) Example: +18665550001</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"to","description":"\n<p>Receiving address (+E.164 formatted phone number.) Example: +18665550001</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_id","full_name":"lead_id","description":"\n<p>Optional. Associate this text message with this lead. The lead&#39;s telephone number will be used as the Receiving address if “to” is not provided.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead}[/api/docs/1.0/leads/index.html]. Refer to: {/api/docs/1.0/leads}[/api/docs/1.0/leads/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message","full_name":"message","description":"\n<p>Message body (i.e., content) as non-empty string. Example: Hello!</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"delivery_webhook_url","full_name":"delivery_webhook_url","description":"\n<p>Webhook to call when the message&#39;s status changes.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"manual","full_name":"manual","description":"\n<p>Pass true if this message is manually initiated by a human being in your application. When this is set to true Trackrive will skip checking if the “to” destination is on the DNC.</p>\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":[]},{"name":"number_id","full_name":"number_id","description":"\n<p>Provide the sending address as an internal Trackdrive telephone number ID.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number}[/api/docs/1.0/phone_numbers/index.html]. Refer to: {/api/docs/1.0/phone_numbers}[/api/docs/1.0/phone_numbers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Optional. If a lead exists on this schedule, this text message will be associated with it. If no lead currently exists, one will be created, and it will be added to this schedule.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"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":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Optional. Associate this text message with a matching lead on this offer. If no lead currently exists, one will be created on this offer.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X POST \"trackdrive.com/api/v1/text_messages?message=Thanks+for+your+inquiry&to=%2B16053334444\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_messages/index","name":"index","apis":[{"api_url":"/api/v1/text_messages","http_method":"GET","short_description":"Retrieves details about text messages.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nfrom\n</li>\n<li class='column-attempt'>\nto\n</li>\n<li class='column-attempt'>\nmessage\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nnumber_id\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\nprovider_configuration_id\n</li>\n<li class='column-attempt'>\nmessage_uuid\n</li>\n<li class='column-attempt'>\ndestination_caller_id\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nerror_code\n</li>\n<li class='column-attempt'>\nring_pool_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nsent_at\n</li>\n<li class='column-attempt'>\nmanual\n</li>\n<li class='column-attempt'>\nsms_blast_id\n</li>\n<li class='column-attempt'>\ncontact_id\n</li>\n<li class='column-attempt'>\ndelivery_webhook_url\n</li>\n<li class='column-attempt'>\ntext_message_flow_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_messages/show","name":"show","apis":[{"api_url":"/api/v1/text_messages/:id","http_method":"GET","short_description":"Retrieves details about a specific text message request.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"thinq_number_files":{"doc_url":"/api/docs/1.0/thinq_number_files","id":"thinq_number_files","api_url":"/api","name":"Thinq DID Uploader","short_description":"API resource for managing Thinq DID Uploader.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/thinq_number_files/index","name":"index","apis":[{"api_url":"/api/v1/thinq_number_files","http_method":"GET","short_description":"List Thinq DID Uploader records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nimport_file_url\n</li>\n<li class='column-attempt'>\nstatus\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n<li class='column-attempt'>\nerror_message\n</li>\n<li class='column-attempt'>\nimport_count\n</li>\n<li class='column-attempt'>\ntotal_count\n</li>\n<li class='column-attempt'>\npaused_at\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/thinq_number_files/new","name":"new","apis":[{"api_url":"/api/v1/thinq_number_files/new","http_method":"GET","short_description":"Build Thinq DID Uploader with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/thinq_number_files/create","name":"create","apis":[{"api_url":"/api/v1/thinq_number_files","http_method":"POST","short_description":"Create Thinq DID Uploader.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/thinq_number_files/show","name":"show","apis":[{"api_url":"/api/v1/thinq_number_files/:id","http_method":"GET","short_description":"Get Thinq DID Uploader by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/thinq_number_files/update","name":"update","apis":[{"api_url":"/api/v1/thinq_number_files/:id","http_method":"PUT","short_description":"Update Thinq DID Uploader by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/thinq_number_files/destroy","name":"destroy","apis":[{"api_url":"/api/v1/thinq_number_files/:id","http_method":"DELETE","short_description":"Translation missing: en.api.thinq_number_files.delete","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"token_matchers":{"doc_url":"/api/docs/1.0/token_matchers","id":"token_matchers","api_url":"/api","name":"Offers: Optimizer Tokens","short_description":"API resource for managing an offer's optimizer tokens.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/token_matchers/index","name":"index","apis":[{"api_url":"/api/v1/token_matchers","http_method":"GET","short_description":"List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.token_matchers.offer_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\ntoken_key\n</li>\n<li class='column-attempt'>\nurl_param_key\n</li>\n<li class='column-attempt'>\nowner_id\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/new","name":"new","apis":[{"api_url":"/api/v1/token_matchers/new","http_method":"GET","short_description":"Build record with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_key","full_name":"token_key","description":"\n<p>The internal token name where values are stored.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url_param_key","full_name":"url_param_key","description":"\n<p>This URL key will be assigned to a Trackdrive Token.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/create","name":"create","apis":[{"api_url":"/api/v1/token_matchers","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_key","full_name":"token_key","description":"\n<p>The internal token name where values are stored.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url_param_key","full_name":"url_param_key","description":"\n<p>This URL key will be assigned to a Trackdrive Token.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/show","name":"show","apis":[{"api_url":"/api/v1/token_matchers/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/update","name":"update","apis":[{"api_url":"/api/v1/token_matchers/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"token_key","full_name":"token_key","description":"\n<p>The internal token name where values are stored.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url_param_key","full_name":"url_param_key","description":"\n<p>This URL key will be assigned to a Trackdrive Token.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/token_matchers/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"token_value_map_groups":{"doc_url":"/api/docs/1.0/token_value_map_groups","id":"token_value_map_groups","api_url":"/api","name":"Field Mapping Group","short_description":"API resource for managing Field Mapping Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/token_value_map_groups/index","name":"index","apis":[{"api_url":"/api/v1/token_value_map_groups","http_method":"GET","short_description":"List Field Mapping Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ntoken_value_maps_count\n</li>\n<li class='column-attempt'>\ntoken_value_map_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/new","name":"new","apis":[{"api_url":"/api/v1/token_value_map_groups/new","http_method":"GET","short_description":"Build Field Mapping Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/create","name":"create","apis":[{"api_url":"/api/v1/token_value_map_groups","http_method":"POST","short_description":"Create Field Mapping Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/show","name":"show","apis":[{"api_url":"/api/v1/token_value_map_groups/:id","http_method":"GET","short_description":"Get Field Mapping Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/update","name":"update","apis":[{"api_url":"/api/v1/token_value_map_groups/:id","http_method":"PUT","short_description":"Update Field Mapping Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/token_value_map_groups/:id","http_method":"DELETE","short_description":"Destroy Field Mapping Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"token_value_maps":{"doc_url":"/api/docs/1.0/token_value_maps","id":"token_value_maps","api_url":"/api","name":"Custom Field Mappings","short_description":"Configure data mappings for custom field values. EG: IF interest EQUALS Raccoons THEN send racoons-29838.  This is useful for integrating with third-party systems that require you to send internal IDs in Webhook Postbacks.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/token_value_maps/index","name":"index","apis":[{"api_url":"/api/v1/token_value_maps","http_method":"GET","short_description":"List field mappings.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Filter for field mappings that are assigned to this webhook.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n<p>Assign the record to this Buyer Conversion Criteria.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\noutgoing_webhook_id\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nvalue\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nvalue_expression\n</li>\n<li class='column-attempt'>\nvalue_type\n</li>\n<li class='column-attempt'>\ntoken_value_map_group_id\n</li>\n<li class='column-attempt'>\nvalue_formatter\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/new","name":"new","apis":[{"api_url":"/api/v1/token_value_maps/new","http_method":"GET","short_description":"Build Field Mapping","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Assign the record to this Outgoing Webhook.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n<p>Assign the record to this Buyer Conversion Criteria.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Translation missing: en.api.token_value_maps.key</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>The value that will be applied if the key_compare and value_compare match the token&#39;s key and value.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Expression Formatter</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/create","name":"create","apis":[{"api_url":"/api/v1/token_value_maps","http_method":"POST","short_description":"Create field mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Assign the record to this Outgoing Webhook.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n<p>Assign the record to this Buyer Conversion Criteria.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Translation missing: en.api.token_value_maps.key</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>The value that will be applied if the key_compare and value_compare match the token&#39;s key and value.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Expression Formatter</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/show","name":"show","apis":[{"api_url":"/api/v1/token_value_maps/:id","http_method":"GET","short_description":"Show field mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/update","name":"update","apis":[{"api_url":"/api/v1/token_value_maps/:id","http_method":"PUT","short_description":"Update field mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Assign the record to this Outgoing Webhook.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n<p>Assign the record to this Buyer Conversion Criteria.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n<p>Assign filters to the object by passing an array of key:value pairs</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:<br><code>\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Translation missing: en.api.token_value_maps.key</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>The value that will be applied if the key_compare and value_compare match the token&#39;s key and value.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\n<p>Expression Formatter</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>string</code>, <code>decimal</code>, <code>integer</code>, <code>time</code>, <code>boolean</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/destroy","name":"destroy","apis":[{"api_url":"/api/v1/token_value_maps/:id","http_method":"DELETE","short_description":"Delete field mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"token_values":{"doc_url":"/api/docs/1.0/token_values","id":"token_values","api_url":"/api","name":"Tokens: Values","short_description":"The token values in your Trackdrive account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/token_values/index","name":"index","apis":[{"api_url":"/api/v1/token_values","http_method":"GET","short_description":"List your token values.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n<p>Filter by this key.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Filter by this value.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_id","full_name":"token_id","description":"\n<p>Filter by this token.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Token}[/api/docs/1.0/tokens/index.html]. Refer to: {/api/docs/1.0/tokens}[/api/docs/1.0/tokens/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operator","full_name":"operator","description":"\n<p>Filter by this operator.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>==</code>, <code>!=</code>, <code>=~</code>, <code>!~</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nvalue\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nis_system_token\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/token_values?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tokens":{"doc_url":"/api/docs/1.0/tokens","id":"tokens","api_url":"/api","name":"Tokens","short_description":"The tokens in your Trackdrive account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/tokens/index","name":"index","apis":[{"api_url":"/api/v1/tokens","http_method":"GET","short_description":"List your tokens.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/tokens?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/show","name":"show","apis":[{"api_url":"/api/v1/tokens/:id","http_method":"GET","short_description":"Get details about a token.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/tokens/1\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/new","name":"new","apis":[{"api_url":"/api/v1/tokens/new","http_method":"GET","short_description":"Build Token with defaults.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/update","name":"update","apis":[{"api_url":"/api/v1/tokens/:id","http_method":"PUT","short_description":"Update a token.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"color","full_name":"color","description":"\n<p>Background Color</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\n<p>Background Color</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>Translation missing: en.api.tokens.sortable_order</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/tokens/1\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/destroy","name":"destroy","apis":[{"api_url":"/api/v1/tokens/:id","http_method":"DELETE","short_description":"Destroy Token by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/tokens/:id\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/fields","name":"fields","apis":[{"api_url":"/api/v1/tokens/fields","http_method":"GET","short_description":"Get details about a token.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n<p>Translation missing: en.api.lead_token</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"trackdrive_table_collections":{"doc_url":"/api/docs/1.0/trackdrive_table_collections","id":"trackdrive_table_collections","api_url":"/api","name":"Trackdrive Table Collection","short_description":"API resource for managing Trackdrive Table Collection.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/trackdrive_table_collections/index","name":"index","apis":[{"api_url":"/api/v1/trackdrive_table_collections","http_method":"GET","short_description":"List Trackdrive Table Collection records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nslug\n</li>\n<li class='column-attempt'>\ntrackdrive_table_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/new","name":"new","apis":[{"api_url":"/api/v1/trackdrive_table_collections/new","http_method":"GET","short_description":"Build Trackdrive Table Collection with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n<p>User</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"slug","full_name":"slug","description":"\n<p>Slug</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/create","name":"create","apis":[{"api_url":"/api/v1/trackdrive_table_collections","http_method":"POST","short_description":"Create Trackdrive Table Collection.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n<p>User</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"slug","full_name":"slug","description":"\n<p>Slug</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/show","name":"show","apis":[{"api_url":"/api/v1/trackdrive_table_collections/:id","http_method":"GET","short_description":"Get Trackdrive Table Collection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/update","name":"update","apis":[{"api_url":"/api/v1/trackdrive_table_collections/:id","http_method":"PUT","short_description":"Update Trackdrive Table Collection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n<p>User</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"slug","full_name":"slug","description":"\n<p>Slug</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Created At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Updated At</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/destroy","name":"destroy","apis":[{"api_url":"/api/v1/trackdrive_table_collections/:id","http_method":"DELETE","short_description":"Destroy Trackdrive Table Collection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"trackdrive_tables":{"doc_url":"/api/docs/1.0/trackdrive_tables","id":"trackdrive_tables","api_url":"/api","name":"Trackdrive Table","short_description":"API resource for managing Trackdrive Table.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/trackdrive_tables/index","name":"index","apis":[{"api_url":"/api/v1/trackdrive_tables","http_method":"GET","short_description":"List Trackdrive Table records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\ndevice\n</li>\n<li class='column-attempt'>\nurl_path\n</li>\n<li class='column-attempt'>\neditable\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ntrackdrive_table_collection_id\n</li>\n<li class='column-attempt'>\ncolumn_state\n</li>\n<li class='column-attempt'>\nfilter_model\n</li>\n<li class='column-attempt'>\nsort_model\n</li>\n<li class='column-attempt'>\ntrackdrive_model\n</li>\n<li class='column-attempt'>\ncategory\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/new","name":"new","apis":[{"api_url":"/api/v1/trackdrive_tables/new","http_method":"GET","short_description":"Build Trackdrive Table with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trackdrive_table_collection_id","full_name":"trackdrive_table_collection_id","description":"\n<p>Trackdrive Table Collection</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/create","name":"create","apis":[{"api_url":"/api/v1/trackdrive_tables","http_method":"POST","short_description":"Create Trackdrive Table.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trackdrive_table_collection_id","full_name":"trackdrive_table_collection_id","description":"\n<p>Trackdrive Table Collection</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/show","name":"show","apis":[{"api_url":"/api/v1/trackdrive_tables/:id","http_method":"GET","short_description":"Get Trackdrive Table by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/update","name":"update","apis":[{"api_url":"/api/v1/trackdrive_tables/:id","http_method":"PUT","short_description":"Update Trackdrive Table by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trackdrive_table_collection_id","full_name":"trackdrive_table_collection_id","description":"\n<p>Trackdrive Table Collection</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/destroy","name":"destroy","apis":[{"api_url":"/api/v1/trackdrive_tables/:id","http_method":"DELETE","short_description":"Destroy Trackdrive Table by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"traffic_sources":{"doc_url":"/api/docs/1.0/traffic_sources","id":"traffic_sources","api_url":"/api","name":"Traffic Sources","short_description":"API resource for managing Traffic Source.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/traffic_sources/index","name":"index","apis":[{"api_url":"/api/v1/traffic_sources","http_method":"GET","short_description":"List Traffic Source records.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n<p>Sort results by this field.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>created_at</code>, <code>updated_at</code>, <code>first_name</code>, <code>last_name</code>, <code>company_name</code>, <code>numbers_count</code>, <code>recent_calls_count</code>, <code>last_call_at</code>, <code>calls_count</code>, <code>user_traffic_source_id</code>, <code>number_limit</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_dir","full_name":"order_dir","description":"\n<p>Sort results in ascending or descending order.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>asc</code>, <code>desc</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nuser_traffic_source_id\n</li>\n<li class='column-attempt'>\nfirst_name\n</li>\n<li class='column-attempt'>\nlast_name\n</li>\n<li class='column-attempt'>\ncompany_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nnumber_limit\n</li>\n<li class='column-attempt'>\npaused\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nlast_call_at\n</li>\n<li class='column-attempt'>\nnumbers_count\n</li>\n<li class='column-attempt'>\ncalls_count\n</li>\n<li class='column-attempt'>\nrecent_calls_count\n</li>\n<li class='column-attempt'>\nnumber_ids\n</li>\n<li class='column-attempt'>\ntemplate_description\n</li>\n<li class='column-attempt'>\ntemplate_enabled\n</li>\n<li class='column-attempt'>\ntemplate_tier\n</li>\n<li class='column-attempt'>\ntemplate_copy_on_company_create\n</li>\n<li class='column-attempt'>\noutgoing_webhook_ids\n</li>\n<li class='column-attempt'>\nteam_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/traffic_sources?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_sources/create","name":"create","apis":[{"api_url":"/api/v1/traffic_sources","http_method":"POST","short_description":"Create Traffic Source.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"user_traffic_source_id","full_name":"user_traffic_source_id","description":"\n<p>Your external ID assigned to this traffic source.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"first_name","full_name":"first_name","description":"\n<p>First Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\n<p>First Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"company_name","full_name":"company_name","description":"\n<p>Company Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_limit","full_name":"number_limit","description":"\n<p>Number Limit</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\n<p>Give this Traffic Source access to this Offer.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revoke_team_offer_id","full_name":"revoke_team_offer_id","description":"\n<p>Remove access to this Offer for this Traffic Source.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_team","full_name":"generate_team","description":"\n<p>Grant access to this Traffic Source, and calls that it publishes.</p>\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":[]},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n<p>The selected users will recieve an email invitation to collaborate on your company.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: <code>[\"john-smith@gmail.com\", \"example@domain.com\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n<p>Team members will be able to buy numbers for these offers, and view calls published to them by their Traffic Source.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"user_traffic_source_id\":\"xyz\",\"first_name\":\"name\", \"generate_team\":\"true\", team_users_emails: [\"john-smith@gmail.com\"], team_offer_ids: [58923]}' https://[your-subdomain].trackdrive.com/api/v1/traffic_sources"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_sources/show","name":"show","apis":[{"api_url":"/api/v1/traffic_sources/:id","http_method":"GET","short_description":"Get Traffic Source by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_sources/update","name":"update","apis":[{"api_url":"/api/v1/traffic_sources/:id","http_method":"PUT","short_description":"Update Traffic Source by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"user_traffic_source_id","full_name":"user_traffic_source_id","description":"\n<p>Your external ID assigned to this traffic source.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"first_name","full_name":"first_name","description":"\n<p>First Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\n<p>First Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"company_name","full_name":"company_name","description":"\n<p>Company Name</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_limit","full_name":"number_limit","description":"\n<p>Number Limit</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\n<p>Give this Traffic Source access to this Offer.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revoke_team_offer_id","full_name":"revoke_team_offer_id","description":"\n<p>Remove access to this Offer for this Traffic Source.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_team","full_name":"generate_team","description":"\n<p>Grant access to this Traffic Source, and calls that it publishes.</p>\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":[]},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n<p>The selected users will recieve an email invitation to collaborate on your company.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: <code>[\"john-smith@gmail.com\", \"example@domain.com\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n<p>Team members will be able to buy numbers for these offers, and view calls published to them by their Traffic Source.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"user_traffic_source_id\":\"new_user_ts_id\",\"first_name\":\"new name\"}' https://[your-subdomain].trackdrive.com/api/v1/traffic_sources/:id"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_sources/destroy","name":"destroy","apis":[{"api_url":"/api/v1/traffic_sources/:id","http_method":"DELETE","short_description":"Destroy Traffic Source by id.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE https://[your-subdomain].trackdrive.com/api/v1/traffic_sources/:id"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcription_flow_groups":{"doc_url":"/api/docs/1.0/transcription_flow_groups","id":"transcription_flow_groups","api_url":"/api","name":"Transcription Flow Group","short_description":"API resource for managing Transcription Flow Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcription_flow_groups/index","name":"index","apis":[{"api_url":"/api/v1/transcription_flow_groups","http_method":"GET","short_description":"List Transcription Flow Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ntranscription_flows_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flow_groups/new","name":"new","apis":[{"api_url":"/api/v1/transcription_flow_groups/new","http_method":"GET","short_description":"Build Transcription Flow Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flow_groups/create","name":"create","apis":[{"api_url":"/api/v1/transcription_flow_groups","http_method":"POST","short_description":"Create Transcription Flow Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flow_groups/show","name":"show","apis":[{"api_url":"/api/v1/transcription_flow_groups/:id","http_method":"GET","short_description":"Get Transcription Flow Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flow_groups/update","name":"update","apis":[{"api_url":"/api/v1/transcription_flow_groups/:id","http_method":"PUT","short_description":"Update Transcription Flow Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flow_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/transcription_flow_groups/:id","http_method":"DELETE","short_description":"Destroy Transcription Flow Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcription_flows":{"doc_url":"/api/docs/1.0/transcription_flows","id":"transcription_flows","api_url":"/api","name":"Transcription Flow","short_description":"API resource for managing Transcription Flow.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcription_flows/index","name":"index","apis":[{"api_url":"/api/v1/transcription_flows","http_method":"GET","short_description":"List Transcription Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\ntranscription_flow_group_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\nrecording_types\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\ntranscription_keyword_group_id\n</li>\n<li class='column-attempt'>\nschedule_action_group_id\n</li>\n<li class='column-attempt'>\nredact_pii\n</li>\n<li class='column-attempt'>\nredact_pii_audio\n</li>\n<li class='column-attempt'>\nredact_pii_sub\n</li>\n<li class='column-attempt'>\nredact_pii_types\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/new","name":"new","apis":[{"api_url":"/api/v1/transcription_flows/new","http_method":"GET","short_description":"Build Transcription Flow with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n<p>Transcription Flow Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recording_types","full_name":"recording_types","description":"\n<p>Recording Types</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/create","name":"create","apis":[{"api_url":"/api/v1/transcription_flows","http_method":"POST","short_description":"Create Transcription Flow.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n<p>Transcription Flow Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recording_types","full_name":"recording_types","description":"\n<p>Recording Types</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/show","name":"show","apis":[{"api_url":"/api/v1/transcription_flows/:id","http_method":"GET","short_description":"Get Transcription Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/update","name":"update","apis":[{"api_url":"/api/v1/transcription_flows/:id","http_method":"PUT","short_description":"Update Transcription Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n<p>Transcription Flow Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recording_types","full_name":"recording_types","description":"\n<p>Recording Types</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n<p>Record Token Filter</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n<p>Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/transcription_flows/:id","http_method":"DELETE","short_description":"Destroy Transcription Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcription_keyword_groups":{"doc_url":"/api/docs/1.0/transcription_keyword_groups","id":"transcription_keyword_groups","api_url":"/api","name":"Keyword Group","short_description":"API resource for managing Keyword Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcription_keyword_groups/index","name":"index","apis":[{"api_url":"/api/v1/transcription_keyword_groups","http_method":"GET","short_description":"List Keyword Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keyword_groups/new","name":"new","apis":[{"api_url":"/api/v1/transcription_keyword_groups/new","http_method":"GET","short_description":"Build Keyword Group with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keyword_groups/create","name":"create","apis":[{"api_url":"/api/v1/transcription_keyword_groups","http_method":"POST","short_description":"Create Keyword Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keyword_groups/show","name":"show","apis":[{"api_url":"/api/v1/transcription_keyword_groups/:id","http_method":"GET","short_description":"Get Keyword Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keyword_groups/update","name":"update","apis":[{"api_url":"/api/v1/transcription_keyword_groups/:id","http_method":"PUT","short_description":"Update Keyword Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keyword_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/transcription_keyword_groups/:id","http_method":"DELETE","short_description":"Destroy Keyword Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcription_keywords":{"doc_url":"/api/docs/1.0/transcription_keywords","id":"transcription_keywords","api_url":"/api","name":"Transcription Keyword","short_description":"API resource for managing Transcription Keyword.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcription_keywords/index","name":"index","apis":[{"api_url":"/api/v1/transcription_keywords","http_method":"GET","short_description":"List Transcription Keyword records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\ntranscription_keyword_group_id\n</li>\n<li class='column-attempt'>\ndetection_channel\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nkeywords\n</li>\n<li class='column-attempt'>\nrecord_token_additional_id\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_additional_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keywords/new","name":"new","apis":[{"api_url":"/api/v1/transcription_keywords/new","http_method":"GET","short_description":"Build Transcription Keyword with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"transcription_keyword_group_id","full_name":"transcription_keyword_group_id","description":"\n<p>Transcription Keyword Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"detection_channel","full_name":"detection_channel","description":"\n<p>Detection Channel</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>caller</code>, <code>others</code>, <code>all</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operator","full_name":"operator","description":"\n<p>Operator</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"values","full_name":"values","description":"\n<p>Values</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keywords","full_name":"keywords","description":"\n<p>Keywords</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keywords/create","name":"create","apis":[{"api_url":"/api/v1/transcription_keywords","http_method":"POST","short_description":"Create Transcription Keyword.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"transcription_keyword_group_id","full_name":"transcription_keyword_group_id","description":"\n<p>Transcription Keyword Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"detection_channel","full_name":"detection_channel","description":"\n<p>Detection Channel</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>caller</code>, <code>others</code>, <code>all</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operator","full_name":"operator","description":"\n<p>Operator</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"values","full_name":"values","description":"\n<p>Values</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keywords","full_name":"keywords","description":"\n<p>Keywords</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keywords/show","name":"show","apis":[{"api_url":"/api/v1/transcription_keywords/:id","http_method":"GET","short_description":"Get Transcription Keyword by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keywords/update","name":"update","apis":[{"api_url":"/api/v1/transcription_keywords/:id","http_method":"PUT","short_description":"Update Transcription Keyword by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"transcription_keyword_group_id","full_name":"transcription_keyword_group_id","description":"\n<p>Transcription Keyword Group</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"detection_channel","full_name":"detection_channel","description":"\n<p>Detection Channel</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>caller</code>, <code>others</code>, <code>all</code>.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operator","full_name":"operator","description":"\n<p>Operator</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"values","full_name":"values","description":"\n<p>Values</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n<p>Record Token Additional</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n<p>Attribution Token Value Ids</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keywords","full_name":"keywords","description":"\n<p>Keywords</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: <code>[\"abc123\", \"xzy023\"]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keywords/destroy","name":"destroy","apis":[{"api_url":"/api/v1/transcription_keywords/:id","http_method":"DELETE","short_description":"Destroy Transcription Keyword by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcriptions":{"doc_url":"/api/docs/1.0/transcriptions","id":"transcriptions","api_url":"/api","name":"Transcription","short_description":"API resource for managing Transcription.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcriptions/index","name":"index","apis":[{"api_url":"/api/v1/transcriptions","http_method":"GET","short_description":"List Transcription records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_id","full_name":"call_id","description":"\n<p>The internal id for a call on Trackdrive.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nfile_url\n</li>\n<li class='column-attempt'>\ntranscription_flow_id\n</li>\n<li class='column-attempt'>\ncall_id\n</li>\n<li class='column-attempt'>\nkeywords\n</li>\n<li class='column-attempt'>\nrecording_type\n</li>\n<li class='column-attempt'>\naudio_duration\n</li>\n<li class='column-attempt'>\nhighlighted_utterances\n</li>\n<li class='column-attempt'>\nutterances\n</li>\n<li class='column-attempt'>\ntranscription_processed\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcriptions/show","name":"show","apis":[{"api_url":"/api/v1/transcriptions/:id","http_method":"GET","short_description":"Get Transcription by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"unblock_contact_jobs":{"doc_url":"/api/docs/1.0/unblock_contact_jobs","id":"unblock_contact_jobs","api_url":"/api","name":"Blacklist: Clear Blacklist","short_description":"API resource for removing all numbers from your blacklist.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/unblock_contact_jobs/index","name":"index","apis":[{"api_url":"/api/v1/unblock_contact_jobs","http_method":"GET","short_description":"List Clear Blacklist records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nblocked_at_from\n</li>\n<li class='column-attempt'>\nblocked_at_to\n</li>\n<li class='column-attempt'>\nrequest_ip\n</li>\n<li class='column-attempt'>\nlast_contact_id\n</li>\n<li class='column-attempt'>\nunblock_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/unblock_contact_jobs/new","name":"new","apis":[{"api_url":"/api/v1/unblock_contact_jobs/new","http_method":"GET","short_description":"Build Clear Blacklist with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"blocked_at_from","full_name":"blocked_at_from","description":"\n<p>Blocked At From</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"blocked_at_to","full_name":"blocked_at_to","description":"\n<p>Blocked At To</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"request_ip","full_name":"request_ip","description":"\n<p>Request Ip</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_contact_id","full_name":"last_contact_id","description":"\n<p>Last Contact</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/unblock_contact_jobs/create","name":"create","apis":[{"api_url":"/api/v1/unblock_contact_jobs","http_method":"POST","short_description":"Create Clear Blacklist.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"blocked_at_from","full_name":"blocked_at_from","description":"\n<p>Blocked At From</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"blocked_at_to","full_name":"blocked_at_to","description":"\n<p>Blocked At To</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"request_ip","full_name":"request_ip","description":"\n<p>Request Ip</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_contact_id","full_name":"last_contact_id","description":"\n<p>Last Contact</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/unblock_contact_jobs/show","name":"show","apis":[{"api_url":"/api/v1/unblock_contact_jobs/:id","http_method":"GET","short_description":"Get Clear Blacklist by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/unblock_contact_jobs/destroy","name":"destroy","apis":[{"api_url":"/api/v1/unblock_contact_jobs/:id","http_method":"DELETE","short_description":"Destroy Clear Blacklist by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"uncompleted_calls":{"doc_url":"/api/docs/1.0/uncompleted_calls","id":"uncompleted_calls","api_url":"/api","name":"Uncompleted Calls","short_description":"API resource for managing Uncompleted Calls.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/uncompleted_calls/index","name":"index","apis":[{"api_url":"/api/v1/uncompleted_calls","http_method":"GET","short_description":"List Uncompleted Calls records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nnumber_id\n</li>\n<li class='column-attempt'>\ndirection\n</li>\n<li class='column-attempt'>\nfrom_number\n</li>\n<li class='column-attempt'>\nto_number\n</li>\n<li class='column-attempt'>\nhuman_reject_reason\n</li>\n<li class='column-attempt'>\nreject_reason\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"upstream_numbers":{"doc_url":"/api/docs/1.0/upstream_numbers","id":"upstream_numbers","api_url":"/api","name":"Upstream Number","short_description":"API resource for managing Upstream Number.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/upstream_numbers/index","name":"index","apis":[{"api_url":"/api/v1/upstream_numbers","http_method":"GET","short_description":"List Upstream Number records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nnumber\n</li>\n<li class='column-attempt'>\nnumber_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nnpanxx\n</li>\n<li class='column-attempt'>\ncompany_name\n</li>\n<li class='column-attempt'>\ntrunk_id\n</li>\n<li class='column-attempt'>\ntrunk_name\n</li>\n<li class='column-attempt'>\nsms_orig_url\n</li>\n<li class='column-attempt'>\nassigned_name\n</li>\n<li class='column-attempt'>\nnotes\n</li>\n<li class='column-attempt'>\nmonthly_rental_rate\n</li>\n<li class='column-attempt'>\nnumber_type\n</li>\n<li class='column-attempt'>\nregion\n</li>\n<li class='column-attempt'>\nsms_enabled\n</li>\n<li class='column-attempt'>\nsms_rate\n</li>\n<li class='column-attempt'>\nvoice_enabled\n</li>\n<li class='column-attempt'>\nvoice_rate\n</li>\n<li class='column-attempt'>\ntoll_free\n</li>\n<li class='column-attempt'>\ncountry\n</li>\n<li class='column-attempt'>\ncarrier_tier\n</li>\n<li class='column-attempt'>\nocn\n</li>\n<li class='column-attempt'>\nlata\n</li>\n<li class='column-attempt'>\nstate\n</li>\n<li class='column-attempt'>\nratecenter\n</li>\n<li class='column-attempt'>\ntag\n</li>\n<li class='column-attempt'>\nrouting_origination\n</li>\n<li class='column-attempt'>\nrouting_tf_lcr\n</li>\n<li class='column-attempt'>\nsite\n</li>\n<li class='column-attempt'>\ncnam_in\n</li>\n<li class='column-attempt'>\ne_nine_eleven\n</li>\n<li class='column-attempt'>\ndisconnected_at\n</li>\n<li class='column-attempt'>\nunrented_at\n</li>\n<li class='column-attempt'>\ntrackdrive_number_deleted_at\n</li>\n<li class='column-attempt'>\napplication_id\n</li>\n<li class='column-attempt'>\ncarrier_type\n</li>\n<li class='column-attempt'>\nclean_number_enabled\n</li>\n<li class='column-attempt'>\nclean_number_last_recycled_at\n</li>\n<li class='column-attempt'>\nclean_number_list_id\n</li>\n<li class='column-attempt'>\nclean_number_state\n</li>\n<li class='column-attempt'>\nclean_number_score\n</li>\n<li class='column-attempt'>\nunassigned\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/upstream_numbers/show","name":"show","apis":[{"api_url":"/api/v1/upstream_numbers/:id","http_method":"GET","short_description":"Get Upstream Number by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"virtual_numbers":{"doc_url":"/api/docs/1.0/virtual_numbers","id":"virtual_numbers","api_url":"/api","name":"Virtual Number","short_description":"API resource for managing Virtual Number.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/virtual_numbers/index","name":"index","apis":[{"api_url":"/api/v1/virtual_numbers","http_method":"GET","short_description":"List Virtual Number records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nnumber\n</li>\n<li class='column-attempt'>\nis_clean_number\n</li>\n<li class='column-attempt'>\ntrackdrive_number_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/virtual_numbers/new","name":"new","apis":[{"api_url":"/api/v1/virtual_numbers/new","http_method":"GET","short_description":"Build Virtual Number with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number","full_name":"number","description":"\n<p>Number</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/virtual_numbers/create","name":"create","apis":[{"api_url":"/api/v1/virtual_numbers","http_method":"POST","short_description":"Create Virtual Number.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number","full_name":"number","description":"\n<p>Number</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\n<p>Refer to the offer api for details</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n<p>Refer to the Number Pool api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n<p>Refer to the traffic source api for details</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"offer_id\": 123,\"traffic_source_id\": 2345, \"number\":\"+18001231234\"}' https://[your-subdomain].trackdrive.com/api/v1/virtual_numbers"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/virtual_numbers/show","name":"show","apis":[{"api_url":"/api/v1/virtual_numbers/:id","http_method":"GET","short_description":"Get Virtual Number by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/virtual_numbers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/virtual_numbers/:id","http_method":"DELETE","short_description":"Destroy Virtual Number by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"visitor_token_matchers":{"doc_url":"/api/docs/1.0/visitor_token_matchers","id":"visitor_token_matchers","api_url":"/api","name":"Offers: Impression Tokens","short_description":"Define the unique url parameters that will be tracked when using Dynamic Number Insertion For example google clickIDs can be tracked: gclid\n","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/visitor_token_matchers/index","name":"index","apis":[{"api_url":"/api/v1/visitor_token_matchers","http_method":"GET","short_description":"List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Translation missing: en.api.visitor_token_matchers.offer_id</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\ntoken\n</li>\n<li class='column-attempt'>\nkey\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/new","name":"new","apis":[{"api_url":"/api/v1/visitor_token_matchers/new","http_method":"GET","short_description":"Build record with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token","full_name":"token","description":"\n<p>The internal token name where values are stored.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>This URL key will be assigned to a Trackdrive Token.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/create","name":"create","apis":[{"api_url":"/api/v1/visitor_token_matchers","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n<p>Assign the record to this Offer.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token","full_name":"token","description":"\n<p>The internal token name where values are stored.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>This URL key will be assigned to a Trackdrive Token.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/show","name":"show","apis":[{"api_url":"/api/v1/visitor_token_matchers/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/update","name":"update","apis":[{"api_url":"/api/v1/visitor_token_matchers/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"token","full_name":"token","description":"\n<p>The internal token name where values are stored.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>This URL key will be assigned to a Trackdrive Token.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\n<p>The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/visitor_token_matchers/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"webhook_logs":{"doc_url":"/api/docs/1.0/webhook_logs","id":"webhook_logs","api_url":"/api","name":"Outgoing Webhooks: Logs","short_description":"API resource for viewing Webhook Request Logs.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/webhook_logs/index","name":"index","apis":[{"api_url":"/api/v1/webhook_logs","http_method":"GET","short_description":"List Webhook Logs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nowner_id\n</li>\n<li class='column-attempt'>\nowner_type\n</li>\n<li class='column-attempt'>\nrequest_url\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\ncall_id\n</li>\n<li class='column-attempt'>\ncode\n</li>\n<li class='column-attempt'>\nresponse_body\n</li>\n<li class='column-attempt'>\noutgoing_webhook_id\n</li>\n<li class='column-attempt'>\noutgoing_webhook_url_id\n</li>\n<li class='column-attempt'>\nrequest_method\n</li>\n<li class='column-attempt'>\noffer_id\n</li>\n<li class='column-attempt'>\nbuyer_id\n</li>\n<li class='column-attempt'>\ntraffic_source_id\n</li>\n<li class='column-attempt'>\nbuyer_group_id\n</li>\n<li class='column-attempt'>\nschedule_id\n</li>\n<li class='column-attempt'>\nresponse_headers\n</li>\n<li class='column-attempt'>\nrequest_headers\n</li>\n<li class='column-attempt'>\nrequest_body\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\nduration\n</li>\n<li class='column-attempt'>\ntrackdrive_notes\n</li>\n<li class='column-attempt'>\nread_from_cache\n</li>\n<li class='column-attempt'>\nresponse_parsers\n</li>\n<li class='column-attempt'>\nzoho_crm_command_id\n</li>\n<li class='column-attempt'>\ncall_disposition_key\n</li>\n<li class='column-attempt'>\nlead_created_at\n</li>\n<li class='column-attempt'>\ncaller_number\n</li>\n<li class='column-attempt'>\nsource_ip\n</li>\n<li class='column-attempt'>\nping_before_calling\n</li>\n<li class='column-attempt'>\ncall_uuid\n</li>\n<li class='column-attempt'>\ninbound_webhook_id\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_logs/show","name":"show","apis":[{"api_url":"/api/v1/webhook_logs/:id","http_method":"GET","short_description":"Show A Webhook Log.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"webhook_manual_fires":{"doc_url":"/api/docs/1.0/webhook_manual_fires","id":"webhook_manual_fires","api_url":"/api","name":"Outgoing Webhooks: Manually Fire A Webhook","short_description":"API resource for manually firing Webhooks for testing purposes.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/webhook_manual_fires/index","name":"index","apis":[{"api_url":"/api/v1/webhook_manual_fires","http_method":"GET","short_description":"List Test Webhooks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncontext_menu_name\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\noutgoing_webhook_id\n</li>\n<li class='column-attempt'>\nbuyer_conversion_id\n</li>\n<li class='column-attempt'>\nlead_id\n</li>\n<li class='column-attempt'>\ncall_id\n</li>\n<li class='column-attempt'>\nwebhook_log_ids\n</li>\n<li class='column-attempt'>\nlead_log_ids\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_manual_fires/new","name":"new","apis":[{"api_url":"/api/v1/webhook_manual_fires/new","http_method":"GET","short_description":"Build A Manual Webhook Fire Instance","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lead_id","full_name":"lead_id","description":"\n<p>Lead</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead}[/api/docs/1.0/leads/index.html]. Refer to: {/api/docs/1.0/leads}[/api/docs/1.0/leads/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_id","full_name":"call_id","description":"\n<p>Call</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Translation missing: en.api.webhook_manual_fires.created_at</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Translation missing: en.api.webhook_manual_fires.updated_at</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_manual_fires/create","name":"create","apis":[{"api_url":"/api/v1/webhook_manual_fires","http_method":"POST","short_description":"Manually Fire A Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\n<p>Outgoing Webhook</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n<p>Translation missing: en.api.webhook_manual_fires.buyer_conversion_id</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_id","full_name":"lead_id","description":"\n<p>Lead</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead}[/api/docs/1.0/leads/index.html]. Refer to: {/api/docs/1.0/leads}[/api/docs/1.0/leads/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_id","full_name":"call_id","description":"\n<p>Call</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n<p>Translation missing: en.api.webhook_manual_fires.created_at</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\n<p>Translation missing: en.api.webhook_manual_fires.updated_at</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2024-11-21 08:44:58 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_manual_fires/show","name":"show","apis":[{"api_url":"/api/v1/webhook_manual_fires/:id","http_method":"GET","short_description":"Get A Manually Fired Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"webhook_params":{"doc_url":"/api/docs/1.0/webhook_params","id":"webhook_params","api_url":"/api","name":"Webhook Param","short_description":"API resource for managing Webhook Param.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/webhook_params/index","name":"index","apis":[{"api_url":"/api/v1/webhook_params","http_method":"GET","short_description":"List Webhook Param records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nkey\n</li>\n<li class='column-attempt'>\nvalue\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\noutgoing_webhook_url_id\n</li>\n<li class='column-attempt'>\nbuyer_conversion_id\n</li>\n<li class='column-attempt'>\ncall_control_action_id\n</li>\n<li class='column-attempt'>\ninbound_webhook_id\n</li>\n<li class='column-attempt'>\nzoho_crm_command_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_id\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data_count\n</li>\n<li class='column-attempt'>\nrecord_token_filter_data\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_params/new","name":"new","apis":[{"api_url":"/api/v1/webhook_params/new","http_method":"GET","short_description":"Build Webhook Param with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_url_id","full_name":"outgoing_webhook_url_id","description":"\n<p>Outgoing Webhook Url</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_params/create","name":"create","apis":[{"api_url":"/api/v1/webhook_params","http_method":"POST","short_description":"Create Webhook Param.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_url_id","full_name":"outgoing_webhook_url_id","description":"\n<p>Outgoing Webhook Url</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_params/show","name":"show","apis":[{"api_url":"/api/v1/webhook_params/:id","http_method":"GET","short_description":"Get Webhook Param by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_params/update","name":"update","apis":[{"api_url":"/api/v1/webhook_params/:id","http_method":"PUT","short_description":"Update Webhook Param by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_url_id","full_name":"outgoing_webhook_url_id","description":"\n<p>Outgoing Webhook Url</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\n<p>Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n<p>Value</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_params/destroy","name":"destroy","apis":[{"api_url":"/api/v1/webhook_params/:id","http_method":"DELETE","short_description":"Destroy Webhook Param by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"zip_code_list_files":{"doc_url":"/api/docs/1.0/zip_code_list_files","id":"zip_code_list_files","api_url":"/api","name":"Zip Code Lists: CSV Files","short_description":"API resource for managing Zip CSV File.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/zip_code_list_files/index","name":"index","apis":[{"api_url":"/api/v1/zip_code_list_files","http_method":"GET","short_description":"List Zip CSV File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nzip_code_list_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nimport_file_url\n</li>\n<li class='column-attempt'>\nzip_codes\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\nzip_codes_count\n</li>\n<li class='column-attempt'>\nstarted_at\n</li>\n<li class='column-attempt'>\nstopped_at\n</li>\n<li class='column-attempt'>\nsucceeded_at\n</li>\n<li class='column-attempt'>\nfailed_at\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_list_files/new","name":"new","apis":[{"api_url":"/api/v1/zip_code_list_files/new","http_method":"GET","short_description":"Build Zip CSV File with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_list_files/create","name":"create","apis":[{"api_url":"/api/v1/zip_code_list_files","http_method":"POST","short_description":"Create Zip CSV File.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"zip_code_list_id","full_name":"zip_code_list_id","description":"\n<p>Zip Code List</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_list_files/show","name":"show","apis":[{"api_url":"/api/v1/zip_code_list_files/:id","http_method":"GET","short_description":"Get Zip CSV File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_list_files/update","name":"update","apis":[{"api_url":"/api/v1/zip_code_list_files/:id","http_method":"PUT","short_description":"Update Zip CSV File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"zip_code_list_id","full_name":"zip_code_list_id","description":"\n<p>Zip Code List</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\n<p>Import File</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_list_files/destroy","name":"destroy","apis":[{"api_url":"/api/v1/zip_code_list_files/:id","http_method":"DELETE","short_description":"Destroy Zip CSV File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"zip_code_lists":{"doc_url":"/api/docs/1.0/zip_code_lists","id":"zip_code_lists","api_url":"/api","name":"Zip Code Lists","short_description":"API resource for managing Zip Code List.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/zip_code_lists/index","name":"index","apis":[{"api_url":"/api/v1/zip_code_lists","http_method":"GET","short_description":"List Zip Code List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nname\n</li>\n<li class='column-attempt'>\ndescription\n</li>\n<li class='column-attempt'>\nzip_code_list_file_ids\n</li>\n<li class='column-attempt'>\nzip_codes_count\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_lists/new","name":"new","apis":[{"api_url":"/api/v1/zip_code_lists/new","http_method":"GET","short_description":"Build Zip Code List with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_lists/create","name":"create","apis":[{"api_url":"/api/v1/zip_code_lists","http_method":"POST","short_description":"Create Zip Code List.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_lists/show","name":"show","apis":[{"api_url":"/api/v1/zip_code_lists/:id","http_method":"GET","short_description":"Get Zip Code List by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_lists/update","name":"update","apis":[{"api_url":"/api/v1/zip_code_lists/:id","http_method":"PUT","short_description":"Update Zip Code List by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n<p>Name</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n<p>Description</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_lists/destroy","name":"destroy","apis":[{"api_url":"/api/v1/zip_code_lists/:id","http_method":"DELETE","short_description":"Destroy Zip Code List by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"zoho_crm_commands":{"doc_url":"/api/docs/1.0/zoho_crm_commands","id":"zoho_crm_commands","api_url":"/api","name":"Zoho Action","short_description":"API resource for managing Zoho Action.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/zoho_crm_commands/index","name":"index","apis":[{"api_url":"/api/v1/zoho_crm_commands","http_method":"GET","short_description":"List Zoho Action records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>Return records matching these ids.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: <code>[0, 1, 2, 3]</code>","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n<p>Return the next page of results.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n<p>How many results to return per page. The default is 25.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"created_at_to","full_name":"created_at_to","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_from","full_name":"created_at_from","description":"\n<p>Date formatted like 2016-01-01 12:25:15 -0500</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fulltext","full_name":"fulltext","description":"\n<p>Search for any record that matches this text</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n<p>Date ranges will be parsed using this time zone.</p>\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":[]},{"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<h4>Must be any combination of:</h4>\n<ul class='column-attempts'>\n<li class='column-attempt'>\nid\n</li>\n<li class='column-attempt'>\nlegacy_id\n</li>\n<li class='column-attempt'>\ntype\n</li>\n<li class='column-attempt'>\nuuid\n</li>\n<li class='column-attempt'>\ncreated_at\n</li>\n<li class='column-attempt'>\nupdated_at\n</li>\n<li class='column-attempt'>\ndeleted_at\n</li>\n<li class='column-attempt'>\nuser_updated_at\n</li>\n<li class='column-attempt'>\nroutes_show_path\n</li>\n<li class='column-attempt'>\nroutes_edit_path\n</li>\n<li class='column-attempt'>\nexternal_record_id\n</li>\n<li class='column-attempt'>\ncompany_id\n</li>\n<li class='column-attempt'>\nuser_id\n</li>\n<li class='column-attempt'>\nschedule_action_id\n</li>\n<li class='column-attempt'>\nsortable_order\n</li>\n<li class='column-attempt'>\naction_type\n</li>\n<li class='column-attempt'>\nmodule_type\n</li>\n<li class='column-attempt'>\nmodule_primary_key\n</li>\n<li class='column-attempt'>\ntoken_value_map_group_ids\n</li>\n<li class='column-attempt'>\nwebhook_params_count\n</li>\n<li class='column-attempt'>\nresponse_parsers_count\n</li>\n<li class='column-attempt'>\nzoho_parent_type\n</li>\n</ul>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\n<p>Pass <code>root=false</code> to return results without a root node and metadata.<br> For example:<br> <code>GET /api/v1/calls?root=false</code> will return <code>[call1, call2, call3]</code><br> While:<br> <code>GET /api/v1/calls</code> will return <code>{calls: [call1, call2, call3], metadata: {}}</code><br></p>\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zoho_crm_commands/new","name":"new","apis":[{"api_url":"/api/v1/zoho_crm_commands/new","http_method":"GET","short_description":"Build Zoho Action with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Schedule Action</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_type","full_name":"action_type","description":"\n<p>Action Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_type","full_name":"module_type","description":"\n<p>Module Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_primary_key","full_name":"module_primary_key","description":"\n<p>Module Primary Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zoho_crm_commands/create","name":"create","apis":[{"api_url":"/api/v1/zoho_crm_commands","http_method":"POST","short_description":"Create Zoho Action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Schedule Action</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_type","full_name":"action_type","description":"\n<p>Action Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_type","full_name":"module_type","description":"\n<p>Module Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_primary_key","full_name":"module_primary_key","description":"\n<p>Module Primary Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zoho_crm_commands/show","name":"show","apis":[{"api_url":"/api/v1/zoho_crm_commands/:id","http_method":"GET","short_description":"Get Zoho Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zoho_crm_commands/update","name":"update","apis":[{"api_url":"/api/v1/zoho_crm_commands/:id","http_method":"PUT","short_description":"Update Zoho Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n<p>Schedule Action</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_type","full_name":"action_type","description":"\n<p>Action Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_type","full_name":"module_type","description":"\n<p>Module Type</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_primary_key","full_name":"module_primary_key","description":"\n<p>Module Primary Key</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zoho_crm_commands/destroy","name":"destroy","apis":[{"api_url":"/api/v1/zoho_crm_commands/:id","http_method":"DELETE","short_description":"Destroy Zoho Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}