{"docs":{"name":"TrackDrive","info":"\n\u003cp\u003eTrackdrive API Reference\u003c/p\u003e\n","copyright":null,"doc_url":"/api/docs/1.0","api_url":"/api","resources":{"access_control_lists":{"doc_url":"/api/docs/1.0/access_control_lists","id":"access_control_lists","api_url":"/api","name":"Teams","short_description":"Defines a team's permission policy, controlling which records, actions, and leads its members can access.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nusers_emails\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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},"agent_messages":{"doc_url":"/api/docs/1.0/agent_messages","id":"agent_messages","api_url":"/api","name":"Agent Messages","short_description":"A broadcast message sent to selected agents, buyer groups, or call centers through their agent widget.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_messages/index","name":"index","apis":[{"api_url":"/api/v1/agent_messages","http_method":"GET","short_description":"List Agent Message records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontent\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_status_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_widget_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_messages/new","name":"new","apis":[{"api_url":"/api/v1/agent_messages/new","http_method":"GET","short_description":"Build Agent Message with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"agent_status_id","full_name":"agent_status_id","description":"\n\u003cp\u003eAgent Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Agent Status}[/api/docs/1.0/agent_statuses/index.html]. Refer to: {/api/docs/1.0/agent_statuses}[/api/docs/1.0/agent_statuses/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_messages/create","name":"create","apis":[{"api_url":"/api/v1/agent_messages","http_method":"POST","short_description":"Create Agent Message.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"agent_status_id","full_name":"agent_status_id","description":"\n\u003cp\u003eAgent Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Agent Status}[/api/docs/1.0/agent_statuses/index.html]. Refer to: {/api/docs/1.0/agent_statuses}[/api/docs/1.0/agent_statuses/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eAgents\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eBuyer Groups\u003c/p\u003e\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":[],"deprecated":false},{"name":"call_center_ids","full_name":"call_center_ids","description":"\n\u003cp\u003eCall Centers\u003c/p\u003e\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 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":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_messages/show","name":"show","apis":[{"api_url":"/api/v1/agent_messages/:id","http_method":"GET","short_description":"Get Agent Message 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_messages/update","name":"update","apis":[{"api_url":"/api/v1/agent_messages/:id","http_method":"PUT","short_description":"Update Agent Message by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"agent_status_id","full_name":"agent_status_id","description":"\n\u003cp\u003eAgent Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Agent Status}[/api/docs/1.0/agent_statuses/index.html]. Refer to: {/api/docs/1.0/agent_statuses}[/api/docs/1.0/agent_statuses/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eAgents\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eBuyer Groups\u003c/p\u003e\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":[],"deprecated":false},{"name":"call_center_ids","full_name":"call_center_ids","description":"\n\u003cp\u003eCall Centers\u003c/p\u003e\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 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":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_messages/destroy","name":"destroy","apis":[{"api_url":"/api/v1/agent_messages/:id","http_method":"DELETE","short_description":"Destroy Agent Message by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"agent_status_timestamps":{"doc_url":"/api/docs/1.0/agent_status_timestamps","id":"agent_status_timestamps","api_url":"/api","name":"Agent Status Timestamp","short_description":"A read-only log of when an agent's status changed, used to track availability and timeouts.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_status_timestamps/index","name":"index","apis":[{"api_url":"/api/v1/agent_status_timestamps","http_method":"GET","short_description":"List Agent Status Timestamp records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncollaborator_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_widget_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_status_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_fleets":{"doc_url":"/api/docs/1.0/buyer_fleets","id":"buyer_fleets","api_url":"/api","name":"Buyer Fleets","short_description":"The Buyer Fleets in your account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_fleets/index","name":"index","apis":[{"api_url":"/api/v1/buyer_fleets","http_method":"GET","short_description":"List Buyer Fleet records.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_fleet_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ids\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edesc\u003c/code\u003e, \u003ccode\u003easc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_fleets/show","name":"show","apis":[{"api_url":"/api/v1/buyer_fleets/:id","http_method":"GET","short_description":"Get an individual Buyer Fleet 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_fleets/create","name":"create","apis":[{"api_url":"/api/v1/buyer_fleets","http_method":"POST","short_description":"Create Buyer Fleet.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of the buyer fleet.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA description for this buyer fleet.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_fleet_id","full_name":"user_fleet_id","description":"\n\u003cp\u003eA unique identifier for this fleet. Only lowercase letters, numbers, and underscores are allowed. This ID is used in system tokens to identify fleet membership.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_fleets/update","name":"update","apis":[{"api_url":"/api/v1/buyer_fleets/:id","http_method":"PUT","short_description":"Update an individual Buyer Fleet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of the buyer fleet.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA description for this buyer fleet.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_fleet_id","full_name":"user_fleet_id","description":"\n\u003cp\u003eA unique identifier for this fleet. Only lowercase letters, numbers, and underscores are allowed. This ID is used in system tokens to identify fleet membership.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_fleets/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_fleets/:id","http_method":"DELETE","short_description":"Destroy an individual Buyer Fleet.","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":"List Buyer Group records.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconcurrency_cap_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconcurrency_cap_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmaxed_out\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nweight\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntime_zone\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused_by_user_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nunpaused_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndial_buyers_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_total_limit\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003emaxed_out\u003c/code\u003e, \u003ccode\u003eweight\u003c/code\u003e, \u003ccode\u003etier\u003c/code\u003e, \u003ccode\u003ecap_reset_at\u003c/code\u003e, \u003ccode\u003etime_zone\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003epaused\u003c/code\u003e, \u003ccode\u003epaused_at\u003c/code\u003e, \u003ccode\u003epaused_by_user_id\u003c/code\u003e, \u003ccode\u003eunpaused_at\u003c/code\u003e, \u003ccode\u003euser_updated_at\u003c/code\u003e, \u003ccode\u003edial_buyers_type\u003c/code\u003e, \u003ccode\u003ecall_limits.in_progress_count\u003c/code\u003e, \u003ccode\u003ecall_limits.in_progress_used\u003c/code\u003e, \u003ccode\u003ecall_limits.revenue_hourly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.revenue_daily_used\u003c/code\u003e, \u003ccode\u003ecall_limits.revenue_monthly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.revenue_total_used\u003c/code\u003e, \u003ccode\u003ecall_limits.earned_revenue_hourly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.earned_revenue_daily_used\u003c/code\u003e, \u003ccode\u003ecall_limits.earned_revenue_monthly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.earned_revenue_total_used\u003c/code\u003e, \u003ccode\u003ecall_limits.buyer_conversion_hourly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.buyer_conversion_daily_used\u003c/code\u003e, \u003ccode\u003ecall_limits.buyer_conversion_monthly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.buyer_conversion_total_used\u003c/code\u003e, \u003ccode\u003ecall_limits.connection_hourly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.connection_daily_used\u003c/code\u003e, \u003ccode\u003ecall_limits.connection_monthly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.connection_total_used\u003c/code\u003e, \u003ccode\u003ecall_limits.attempt_hourly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.attempt_daily_used\u003c/code\u003e, \u003ccode\u003ecall_limits.attempt_monthly_used\u003c/code\u003e, \u003ccode\u003ecall_limits.attempt_total_used\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edesc\u003c/code\u003e, \u003ccode\u003easc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"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","http_method":"POST","short_description":"Create Buyer Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of the buyer group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reset_total_caps","full_name":"reset_total_caps","description":"\n\u003cp\u003eSend \u003ccode\u003etrue\u003c/code\u003e to reset the total caps on this buyer group.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_buyers_type","full_name":"dial_buyers_type","description":"\n\u003cp\u003eConfigure the dial buyer behaviour.\u003cbr\u003e \u003ccode\u003esequentially\u003c/code\u003e will dial one buyer a time.\u003cbr\u003e \u003ccode\u003esimultaneously\u003c/code\u003e will dial all buyers in the group at the same time.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esequentially\u003c/code\u003e, \u003ccode\u003esimultaneously\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eThe list of buyer ids that will be dialed.\u003cbr\u003e Example: \u003ccode\u003e[100123, 100124, 1000125]\u003c/code\u003e Obtain internal buyer IDs by making a request to \u003ccode\u003e/api/v1/buyers?columns=name,id,user_buyer_id\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\n\u003cp\u003eAppend buyers to this record.\u003cbr\u003e For example pass: \u003ccode\u003e[100123,100124]\u003c/code\u003e in order to append 100123, and 100124 to the list of buyers in the record.\u003cbr\u003e \u0026lt;strong\u0026gt;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.\u0026lt;/strong\u0026gt;\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"remove_buyer_ids","full_name":"remove_buyer_ids","description":"\n\u003cp\u003eRemove buyers from the record.\u003cbr\u003e For example pass: \u003ccode\u003e[100123]\u003c/code\u003e in order to delete 100123 from the list of buyers in the record.\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"add_user_buyer_ids","full_name":"add_user_buyer_ids","description":"\n\u003cp\u003eAppend buyers to the record using the buyer field \u003ccode\u003euser_buyer_id\u003c/code\u003e\u003cbr\u003e For example pass: \u003ccode\u003e[\u0026quot;loan-22-en\u0026quot;, \u0026quot;loan-23-fr\u0026quot;]\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\n\u003cp\u003eRemove buyers from the record using buyer field \u003ccode\u003euser_buyer_id\u003c/code\u003e\u003cbr\u003e For example pass: \u003ccode\u003e[\u0026quot;loan-23-fr\u0026quot;]\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eWhen \u003ccode\u003edial_buyers_type\u003c/code\u003e is set to \u003ccode\u003esimultaneously\u003c/code\u003e, the buyer group will become prioritized by tier and weight.\u003cbr\u003e Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).\u003cbr\u003e 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weight","full_name":"weight","description":"\n\u003cp\u003eWhen \u003ccode\u003edial_buyers_type\u003c/code\u003e is set to \u003ccode\u003esimultaneously\u003c/code\u003e, the buyer group will become prioritized by tier and weight.\u003cbr\u003e 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"concurrency_cap","full_name":"concurrency_cap","description":"\n\u003cp\u003eThe maximum number of simultaneous calls this buyer group can receive.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this buyer group, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"generate_team","full_name":"generate_team","description":"\n\u003cp\u003eGrant access to manage this buyer group, it’s buyers, and to view calls that it’s paid for.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n\u003cp\u003eThe selected users will recieve an email invitation to collaborate on your company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: \u003ccode\u003e[\"john-smith@gmail.com\", \"example@domain.com\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n\u003cp\u003eTeam members can view calls made to these Offers that were paid for by the buyers in this group.\u003c/p\u003e\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":[],"deprecated":false},{"name":"team_ids","full_name":"team_ids","description":"\n\u003cp\u003eThe selected teams will be granted access to the buyers in this group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\n\u003cp\u003eGive this Buyer Group’s teams access to this Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"revoke_team_offer_id","full_name":"revoke_team_offer_id","description":"\n\u003cp\u003eRemove access to this Offer for this Buyer Group’s teams.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"attempt_total_limit","full_name":"attempt_total_limit","description":"\n\u003cp\u003eAttempt caps limit the number of times a buyer can be attempted in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_monthly_limit","full_name":"attempt_monthly_limit","description":"\n\u003cp\u003eMonthly Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_daily_limit","full_name":"attempt_daily_limit","description":"\n\u003cp\u003eDaily Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_hourly_limit","full_name":"attempt_hourly_limit","description":"\n\u003cp\u003eHourly Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_total_limit","full_name":"connection_total_limit","description":"\n\u003cp\u003eConnection caps limit the number of times a buyer can be connected in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_monthly_limit","full_name":"connection_monthly_limit","description":"\n\u003cp\u003eMonthly Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_daily_limit","full_name":"connection_daily_limit","description":"\n\u003cp\u003eDaily Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_hourly_limit","full_name":"connection_hourly_limit","description":"\n\u003cp\u003eHourly Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_total_limit","full_name":"buyer_conversion_total_limit","description":"\n\u003cp\u003eConversion caps limit the number of times a buyer can convert in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_monthly_limit","full_name":"buyer_conversion_monthly_limit","description":"\n\u003cp\u003eMonthly Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_daily_limit","full_name":"buyer_conversion_daily_limit","description":"\n\u003cp\u003eDaily Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_hourly_limit","full_name":"buyer_conversion_hourly_limit","description":"\n\u003cp\u003eHourly Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_total_limit","full_name":"revenue_total_limit","description":"\n\u003cp\u003eRevenue caps limit the dollar amount that can be paid by a buyer in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_monthly_limit","full_name":"revenue_monthly_limit","description":"\n\u003cp\u003eMonthly $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_daily_limit","full_name":"revenue_daily_limit","description":"\n\u003cp\u003eDaily $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_hourly_limit","full_name":"revenue_hourly_limit","description":"\n\u003cp\u003eHourly $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":null,"full_description":"","errors":[],"params":[{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of the buyer group.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reset_total_caps","full_name":"reset_total_caps","description":"\n\u003cp\u003eSend \u003ccode\u003etrue\u003c/code\u003e to reset the total caps on this buyer group.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_buyers_type","full_name":"dial_buyers_type","description":"\n\u003cp\u003eConfigure the dial buyer behaviour.\u003cbr\u003e \u003ccode\u003esequentially\u003c/code\u003e will dial one buyer a time.\u003cbr\u003e \u003ccode\u003esimultaneously\u003c/code\u003e will dial all buyers in the group at the same time.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esequentially\u003c/code\u003e, \u003ccode\u003esimultaneously\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\n\u003cp\u003eAppend buyers to this record.\u003cbr\u003e For example pass: \u003ccode\u003e[100123,100124]\u003c/code\u003e in order to append 100123, and 100124 to the list of buyers in the record.\u003cbr\u003e \u0026lt;strong\u0026gt;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.\u0026lt;/strong\u0026gt;\u003c/p\u003e\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":[],"deprecated":false},{"name":"remove_buyer_ids","full_name":"remove_buyer_ids","description":"\n\u003cp\u003eRemove buyers from the record.\u003cbr\u003e For example pass: \u003ccode\u003e[100123]\u003c/code\u003e in order to delete 100123 from the list of buyers in the record.\u003cbr\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"add_user_buyer_ids","full_name":"add_user_buyer_ids","description":"\n\u003cp\u003eAppend buyers to the record using the buyer field \u003ccode\u003euser_buyer_id\u003c/code\u003e\u003cbr\u003e For example pass: \u003ccode\u003e[\u0026quot;loan-22-en\u0026quot;, \u0026quot;loan-23-fr\u0026quot;]\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\n\u003cp\u003eRemove buyers from the record using buyer field \u003ccode\u003euser_buyer_id\u003c/code\u003e\u003cbr\u003e For example pass: \u003ccode\u003e[\u0026quot;loan-23-fr\u0026quot;]\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eThe list of buyer ids that will be dialed.\u003cbr\u003e Example: \u003ccode\u003e[100123, 100124, 1000125]\u003c/code\u003e Obtain internal buyer IDs by making a request to \u003ccode\u003e/api/v1/buyers?columns=name,id,user_buyer_id\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eWhen \u003ccode\u003edial_buyers_type\u003c/code\u003e is set to \u003ccode\u003esimultaneously\u003c/code\u003e, the buyer group will become prioritized by tier and weight.\u003cbr\u003e Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).\u003cbr\u003e 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weight","full_name":"weight","description":"\n\u003cp\u003eWhen \u003ccode\u003edial_buyers_type\u003c/code\u003e is set to \u003ccode\u003esimultaneously\u003c/code\u003e, the buyer group will become prioritized by tier and weight.\u003cbr\u003e 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"concurrency_cap","full_name":"concurrency_cap","description":"\n\u003cp\u003eThe maximum number of simultaneous calls this buyer group can receive.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this buyer group, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"generate_team","full_name":"generate_team","description":"\n\u003cp\u003eGrant access to manage this buyer group, it’s buyers, and to view calls that it’s paid for.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n\u003cp\u003eThe selected users will recieve an email invitation to collaborate on your company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: \u003ccode\u003e[\"john-smith@gmail.com\", \"example@domain.com\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n\u003cp\u003eTeam members can view calls made to these Offers that were paid for by the buyers in this group.\u003c/p\u003e\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":[],"deprecated":false},{"name":"team_ids","full_name":"team_ids","description":"\n\u003cp\u003eThe selected teams will be granted access to the buyers in this group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\n\u003cp\u003eGive this Buyer Group’s teams access to this Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"revoke_team_offer_id","full_name":"revoke_team_offer_id","description":"\n\u003cp\u003eRemove access to this Offer for this Buyer Group’s teams.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"attempt_total_limit","full_name":"attempt_total_limit","description":"\n\u003cp\u003eAttempt caps limit the number of times a buyer can be attempted in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_monthly_limit","full_name":"attempt_monthly_limit","description":"\n\u003cp\u003eMonthly Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_daily_limit","full_name":"attempt_daily_limit","description":"\n\u003cp\u003eDaily Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_hourly_limit","full_name":"attempt_hourly_limit","description":"\n\u003cp\u003eHourly Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_total_limit","full_name":"connection_total_limit","description":"\n\u003cp\u003eConnection caps limit the number of times a buyer can be connected in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_monthly_limit","full_name":"connection_monthly_limit","description":"\n\u003cp\u003eMonthly Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_daily_limit","full_name":"connection_daily_limit","description":"\n\u003cp\u003eDaily Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_hourly_limit","full_name":"connection_hourly_limit","description":"\n\u003cp\u003eHourly Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_total_limit","full_name":"buyer_conversion_total_limit","description":"\n\u003cp\u003eConversion caps limit the number of times a buyer can convert in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_monthly_limit","full_name":"buyer_conversion_monthly_limit","description":"\n\u003cp\u003eMonthly Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_daily_limit","full_name":"buyer_conversion_daily_limit","description":"\n\u003cp\u003eDaily Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_hourly_limit","full_name":"buyer_conversion_hourly_limit","description":"\n\u003cp\u003eHourly Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_total_limit","full_name":"revenue_total_limit","description":"\n\u003cp\u003eRevenue caps limit the dollar amount that can be paid by a buyer in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_monthly_limit","full_name":"revenue_monthly_limit","description":"\n\u003cp\u003eMonthly $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_daily_limit","full_name":"revenue_daily_limit","description":"\n\u003cp\u003eDaily $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_hourly_limit","full_name":"revenue_hourly_limit","description":"\n\u003cp\u003eHourly $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":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 Files","short_description":"A CSV upload job that bulk adds or removes phone numbers from a buyer suppression list.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_suppression_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_block_or_unblock\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_id_column_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nerror_message\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntotal_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstopped_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfailed_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsucceeded_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nheaders\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n\u003cp\u003eBuyer Suppression\u003c/p\u003e\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":[],"deprecated":false},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n\u003cp\u003eApply Block Or Unblock\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eImport File\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n\u003cp\u003eCaller Id Column Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"headers","full_name":"headers","description":"\n\u003cp\u003eThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n\u003cp\u003eBuyer Suppression\u003c/p\u003e\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":[],"deprecated":false},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n\u003cp\u003eApply Block Or Unblock\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eImport File\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n\u003cp\u003eCaller Id Column Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"headers","full_name":"headers","description":"\n\u003cp\u003eThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n\u003cp\u003eBuyer Suppression\u003c/p\u003e\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":[],"deprecated":false},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n\u003cp\u003eApply Block Or Unblock\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eImport File\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n\u003cp\u003eCaller Id Column Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"headers","full_name":"headers","description":"\n\u003cp\u003eThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Do-not-call lists of phone numbers that block matching contacts from being sent to associated offers, schedules, or 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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_id_column_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nheaders\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nblocked\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nerror_message\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntotal_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_percent\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfailed_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstopped_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsucceeded_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_ids\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n\u003cp\u003eCaller Id Column Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eThe list of internal buyer ID’s that will use this suppression list.\u003c/p\u003e\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":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eImport File\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n\u003cp\u003eCaller Id Column Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eThe list of internal buyer ID’s that will use this suppression list.\u003c/p\u003e\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":[],"deprecated":false},{"name":"headers","full_name":"headers","description":"\n\u003cp\u003eThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\n\u003cp\u003eAppend buyers to this record.\u003cbr\u003e For example pass: \u003ccode\u003e[100123,100124]\u003c/code\u003e in order to append 100123, and 100124 to the list of buyers in the record.\u003cbr\u003e \u0026lt;strong\u0026gt;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.\u0026lt;/strong\u0026gt;\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"remove_buyer_ids","full_name":"remove_buyer_ids","description":"\n\u003cp\u003eRemove buyers from the record.\u003cbr\u003e For example pass: \u003ccode\u003e[100123]\u003c/code\u003e in order to delete 100123 from the list of buyers in the record.\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"add_user_buyer_ids","full_name":"add_user_buyer_ids","description":"\n\u003cp\u003eAppend buyers to the record using the buyer field \u003ccode\u003euser_buyer_id\u003c/code\u003e\u003cbr\u003e For example pass: \u003ccode\u003e[\u0026quot;loan-22-en\u0026quot;, \u0026quot;loan-23-fr\u0026quot;]\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\n\u003cp\u003eRemove buyers from the record using buyer field \u003ccode\u003euser_buyer_id\u003c/code\u003e\u003cbr\u003e For example pass: \u003ccode\u003e[\u0026quot;loan-23-fr\u0026quot;]\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id_column_name","full_name":"caller_id_column_name","description":"\n\u003cp\u003eCaller Id Column Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eThe list of internal buyer ID’s that will use this suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"headers","full_name":"headers","description":"\n\u003cp\u003eThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\n\u003cp\u003eAppend buyers to this record.\u003cbr\u003e For example pass: \u003ccode\u003e[100123,100124]\u003c/code\u003e in order to append 100123, and 100124 to the list of buyers in the record.\u003cbr\u003e \u0026lt;strong\u0026gt;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.\u0026lt;/strong\u0026gt;\u003c/p\u003e\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":[],"deprecated":false},{"name":"remove_buyer_ids","full_name":"remove_buyer_ids","description":"\n\u003cp\u003eRemove buyers from the record.\u003cbr\u003e For example pass: \u003ccode\u003e[100123]\u003c/code\u003e in order to delete 100123 from the list of buyers in the record.\u003cbr\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"add_user_buyer_ids","full_name":"add_user_buyer_ids","description":"\n\u003cp\u003eAppend buyers to the record using the buyer field \u003ccode\u003euser_buyer_id\u003c/code\u003e\u003cbr\u003e For example pass: \u003ccode\u003e[\u0026quot;loan-22-en\u0026quot;, \u0026quot;loan-23-fr\u0026quot;]\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\n\u003cp\u003eRemove buyers from the record using buyer field \u003ccode\u003euser_buyer_id\u003c/code\u003e\u003cbr\u003e For example pass: \u003ccode\u003e[\u0026quot;loan-23-fr\u0026quot;]\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 phone numbers to a suppression list","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_ids","full_name":"caller_ids","description":"\n\u003cp\u003eAn array of phone numbers to block.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 phone numbers from a suppression list","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_ids","full_name":"caller_ids","description":"\n\u003cp\u003eAn array of phone numbers to block.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 people or companies who pay for your calls and leads, with hours, caps, and conversion rules that define revenue.","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":"List the buyers in your Trackdrive account.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ebuyer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number","full_name":"number","description":"\n\u003cp\u003eFilter buyers for a telephone number.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003eFilter buyers that are either paused or unpaused.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nemail\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntime_zone\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_buyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbid_price\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroute_by_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_names\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_values\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_values_hash\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattribution_token_values\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattribution_token_values_hash\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_call_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nweight\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntimeout_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndtmf_tones\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconcurrency_cap_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconcurrency_cap_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmaxed_out_by\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_revenue_max\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_revenue_min\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_revenue_increment\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_revenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_duplicate_timeframe\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_token_value_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncurrent_conversion_attribution_token_value_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nping_timeout_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_suppression_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_daily_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_hourly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_monthly_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_total_used\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempt_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnection_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nearned_revenue_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_daily_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_hourly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_monthly_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_total_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbusiness_hours_schedule\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversions_schedule\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecalls_count\u003c/code\u003e, \u003ccode\u003erecent_calls_count\u003c/code\u003e, \u003ccode\u003eoutgoing_webhooks_count\u003c/code\u003e, \u003ccode\u003epaused\u003c/code\u003e, \u003ccode\u003enumber\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003elast_call_at\u003c/code\u003e, \u003ccode\u003etier\u003c/code\u003e, \u003ccode\u003eweight\u003c/code\u003e, \u003ccode\u003etime_zone\u003c/code\u003e, \u003ccode\u003euser_buyer_id\u003c/code\u003e, \u003ccode\u003erevenue_hourly_used\u003c/code\u003e, \u003ccode\u003erevenue_daily_used\u003c/code\u003e, \u003ccode\u003erevenue_monthly_used\u003c/code\u003e, \u003ccode\u003erevenue_total_used\u003c/code\u003e, \u003ccode\u003eearned_revenue_hourly_used\u003c/code\u003e, \u003ccode\u003eearned_revenue_daily_used\u003c/code\u003e, \u003ccode\u003eearned_revenue_monthly_used\u003c/code\u003e, \u003ccode\u003eearned_revenue_total_used\u003c/code\u003e, \u003ccode\u003ebuyer_conversion_hourly_used\u003c/code\u003e, \u003ccode\u003ebuyer_conversion_daily_used\u003c/code\u003e, \u003ccode\u003ebuyer_conversion_monthly_used\u003c/code\u003e, \u003ccode\u003ebuyer_conversion_total_used\u003c/code\u003e, \u003ccode\u003econnection_hourly_used\u003c/code\u003e, \u003ccode\u003econnection_daily_used\u003c/code\u003e, \u003ccode\u003econnection_monthly_used\u003c/code\u003e, \u003ccode\u003econnection_total_used\u003c/code\u003e, \u003ccode\u003eattempt_hourly_used\u003c/code\u003e, \u003ccode\u003eattempt_daily_used\u003c/code\u003e, \u003ccode\u003eattempt_monthly_used\u003c/code\u003e, \u003ccode\u003eattempt_total_used\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edesc\u003c/code\u003e, \u003ccode\u003easc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 a buyer by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ebuyer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 by your buyer ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ebuyer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 a buyer with Trackdrive's internal ID.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ebuyer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"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":[],"deprecated":false},{"name":"user_buyer_id","full_name":"user_buyer_id","description":"\n\u003cp\u003eYour external ID for this buyer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number","full_name":"number","description":"\n\u003cp\u003eThe 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 ‘sip:’.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name for this buyer that will appear on menus and in logs.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timeout_seconds","full_name":"timeout_seconds","description":"\n\u003cp\u003eDetermines 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dtmf_tones","full_name":"dtmf_tones","description":"\n\u003cp\u003ePlay 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 ‘w’ characters. Each ‘w’ character waits 0.5 second before sending a digit. Each ‘W’ character waits 1 second before sending a digit.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_caller_name","full_name":"dial_caller_name","description":"\n\u003cp\u003eThe caller name announced to this buyer when the call connects, with tokens replaced before it is sent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delay_calling_buyer_seconds","full_name":"delay_calling_buyer_seconds","description":"\n\u003cp\u003eThe number of seconds Trackdrive waits before dialing this buyer after a call is ready to transfer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sip_username","full_name":"sip_username","description":"\n\u003cp\u003eThe SIP username used when dialing this buyer’s \u003ccode\u003esip:\u003c/code\u003e endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sip_password","full_name":"sip_password","description":"\n\u003cp\u003eThe SIP password used when dialing this buyer’s \u003ccode\u003esip:\u003c/code\u003e endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_platform_id","full_name":"external_platform_id","description":"\n\u003cp\u003eThe known third-party platform this buyer’s number or SIP endpoint belongs to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"buyer_fleet_id","full_name":"buyer_fleet_id","description":"\n\u003cp\u003eThe \u003ccode\u003eBuyerFleet\u003c/code\u003e this buyer is grouped under.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Buyer Fleet}[/api/docs/1.0/buyer_fleets/index.html]. Refer to: {/api/docs/1.0/buyer_fleets}[/api/docs/1.0/buyer_fleets/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_suppression_ids","full_name":"buyer_suppression_ids","description":"\n\u003cp\u003eThe list of internal suppression id’s that will be assigned to this buyer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eCallers will be routed to Buyers with matching tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eWhen this Buyer is connected to a Caller, the Call will be tagged with these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause the buyer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls","full_name":"record_calls","description":"\n\u003cp\u003eEnable or Disable call recordings for this Buyer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls_require_authorization","full_name":"record_calls_require_authorization","description":"\n\u003cp\u003eRequire a Trackdrive user logged into your company to have permission to download call recordings for calls transferred to this buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"press_one_to_accept","full_name":"press_one_to_accept","description":"\n\u003cp\u003eAfter answering the call the Buyer must Press 1 before being connected to the Caller.\u003cbr\u003e Trackdrive will use the “Press 1 To Accept” call routing from the current Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"generate_team","full_name":"generate_team","description":"\n\u003cp\u003eGrant access to edit this Buyer, and view calls that it paid for.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n\u003cp\u003eThe selected users will recieve an email invitation to collaborate on your company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: \u003ccode\u003e[\"john-smith@gmail.com\", \"example@domain.com\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n\u003cp\u003eTeam members can view calls made to these Offers that were paid for by their Buyer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"route_by_type","full_name":"route_by_type","description":"\n\u003cp\u003eConfigure 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etier\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003eepc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eWhen 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"epc_timeframe","full_name":"epc_timeframe","description":"\n\u003cp\u003eThe number of hours used when calculating the \u003ccode\u003eEPC\u003c/code\u003e. If there are less than \u003ccode\u003eMinimum Required Calls\u003c/code\u003e in this timeframe the \u003ccode\u003eAssumed EPC\u003c/code\u003e will be used instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"epc_assumed_amount","full_name":"epc_assumed_amount","description":"\n\u003cp\u003eThe \u003ccode\u003eAssumed EPC\u003c/code\u003e will be used until the Buyer has received \u003ccode\u003eMinimum Required Calls\u003c/code\u003e calls during the \u003ccode\u003eEPC Timeframe\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"epc_assumed_calls_count","full_name":"epc_assumed_calls_count","description":"\n\u003cp\u003eThe number of calls required during \u003ccode\u003eEPC Timeframe\u003c/code\u003e before the real \u003ccode\u003eEPC\u003c/code\u003e is used insead of the \u003ccode\u003eAssumed EPC\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weight","full_name":"weight","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_prematch_buyer_search","full_name":"use_with_prematch_buyer_search","description":"\n\u003cp\u003eInclude this buyer when Trackdrive searches for a matching buyer before a lead is matched to an offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_ping_before_calling_lead","full_name":"enable_ping_before_calling_lead","description":"\n\u003cp\u003ePing this buyer before calling the lead back, used with off-hook webhook conversions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_conversion_sync","full_name":"webhook_conversion_sync","description":"\n\u003cp\u003eWhen true, Trackdrive waits for this buyer’s webhook conversion ping to respond before pinging the next buyer, instead of pinging all webhook buyers at once.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ping_priority","full_name":"ping_priority","description":"\n\u003cp\u003eThe order this buyer is pinged in relative to other webhook buyers on the same offer. Lower numbers are pinged first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_dynamic_number","full_name":"use_dynamic_number","description":"\n\u003cp\u003eReplace this buyer’s \u003ccode\u003enumber\u003c/code\u003e with \u003ccode\u003edynamic_number\u003c/code\u003e, with its tokens replaced, when dialing this buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dynamic_number","full_name":"dynamic_number","description":"\n\u003cp\u003eThe token-replaced number or SIP address dialed instead of \u003ccode\u003enumber\u003c/code\u003e when \u003ccode\u003euse_dynamic_number\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_key_press_flows","full_name":"use_with_key_press_flows","description":"\n\u003cp\u003eApply a key press flow group to calls transferred to this buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group applied when \u003ccode\u003euse_with_key_press_flows\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_voicemail_sound_playlist_id","full_name":"record_voicemail_sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist played to a caller when this buyer leaves them a voicemail.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display_caller_id_type","full_name":"display_caller_id_type","description":"\n\u003cp\u003eSelect which Caller ID will be sent to this Buyer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edisplay_caller_id\u003c/code\u003e, \u003ccode\u003edisplay_fake_caller_id\u003c/code\u003e, \u003ccode\u003edisplay_trackdrive_number_id\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display_trackdrive_number_id","full_name":"display_trackdrive_number_id","description":"\n\u003cp\u003eThe Trackdrive number to display when display_caller_id_type=display_trackdrive_number_id\u003c/p\u003e\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":[],"deprecated":false},{"name":"concurrency_cap_limit","full_name":"concurrency_cap_limit","description":"\n\u003cp\u003eChoose the number of concurrent calls that can be forwarded to this buyer simultaneously.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"convert_when_downstream_converts","full_name":"convert_when_downstream_converts","description":"\n\u003cp\u003eConvert When Downstream Converts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_total_limit","full_name":"attempt_total_limit","description":"\n\u003cp\u003eAttempt caps limit the number of times a buyer can be attempted in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_monthly_limit","full_name":"attempt_monthly_limit","description":"\n\u003cp\u003eMonthly Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_daily_limit","full_name":"attempt_daily_limit","description":"\n\u003cp\u003eDaily Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_hourly_limit","full_name":"attempt_hourly_limit","description":"\n\u003cp\u003eHourly Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_total_limit","full_name":"connection_total_limit","description":"\n\u003cp\u003eConnection caps limit the number of times a buyer can be connected in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_monthly_limit","full_name":"connection_monthly_limit","description":"\n\u003cp\u003eMonthly Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_daily_limit","full_name":"connection_daily_limit","description":"\n\u003cp\u003eDaily Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_hourly_limit","full_name":"connection_hourly_limit","description":"\n\u003cp\u003eHourly Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_total_limit","full_name":"buyer_conversion_total_limit","description":"\n\u003cp\u003eConversion caps limit the number of times a buyer can convert in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_monthly_limit","full_name":"buyer_conversion_monthly_limit","description":"\n\u003cp\u003eMonthly Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_daily_limit","full_name":"buyer_conversion_daily_limit","description":"\n\u003cp\u003eDaily Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_hourly_limit","full_name":"buyer_conversion_hourly_limit","description":"\n\u003cp\u003eHourly Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_total_limit","full_name":"revenue_total_limit","description":"\n\u003cp\u003eRevenue caps limit the dollar amount that can be paid by a buyer in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_monthly_limit","full_name":"revenue_monthly_limit","description":"\n\u003cp\u003eMonthly $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_daily_limit","full_name":"revenue_daily_limit","description":"\n\u003cp\u003eDaily $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_hourly_limit","full_name":"revenue_hourly_limit","description":"\n\u003cp\u003eHourly $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_hours_schedule","full_name":"business_hours_schedule","description":"\n\u003cp\u003eDay is an integer representing the day of the week, 0..6, with Sunday == 0. [\u003c/p\u003e\n\n\u003cpre class=\"ruby\"\u003e{\n  \u003cspan class=\"ruby-value\"\u003eattempt_hourly_limit\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003econnection_hourly_limit\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003ebuyer_conversion_hourly_limit\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003erevenue_hourly_limit\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003eschedule\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [\n    {\n      \u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e0\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e11:00..13:09\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e, \u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e14:00..15:09\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]\n    },\n    {\n      \u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e1\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e11:10..18:39\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e, \u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e19:10..23:39\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]\n    }\n  ]\n}\n\u003c/pre\u003e\n\n\u003cp\u003e]\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_conversions_schedule","full_name":"buyer_conversions_schedule","description":"\n\u003cp\u003eDay is an integer representing the day of the week, 0..6, with Sunday == 0. [\u003c/p\u003e\n\n\u003cpre class=\"ruby\"\u003e{\n  \u003cspan class=\"ruby-value\"\u003ebuyer_conversions_attributes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [\n    {\n      \u003cspan class=\"ruby-value\"\u003ename\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-string\"\u003e\u0026#39;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e10$ conversion at 1 minute, deduped every 2 hours\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026#39;\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003eduration\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e60\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003erevenue\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003eduplicate_timeframe\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e7200\u003c/span\u003e\n    }\n  ],\n  \u003cspan class=\"ruby-value\"\u003eschedule\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e0\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e1\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e2\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e3\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e4\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e5\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e6\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]}]\n}\n\u003c/pre\u003e\n\n\u003cp\u003e]\u003c/p\u003e\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":[],"deprecated":false},{"name":"current_conversion_revenue_max","full_name":"current_conversion_revenue_max","description":"\n\u003cp\u003eThe maximum valid revenue for the current time frame.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_revenue_min","full_name":"current_conversion_revenue_min","description":"\n\u003cp\u003eThe minimum valid revenue for the current time frame.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_revenue_increment","full_name":"current_conversion_revenue_increment","description":"\n\u003cp\u003eBids must be increased/decreased by this amount for the current time frame.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_revenue","full_name":"current_conversion_revenue","description":"\n\u003cp\u003eThe number of dollars paid per call in increments of $0.01 for the current time frame.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_duration","full_name":"current_conversion_duration","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_duplicate_timeframe","full_name":"current_conversion_duplicate_timeframe","description":"\n\u003cp\u003eThe period of time that must elapse before a buyer will pay for the same caller to be transferred.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_name","full_name":"current_conversion_name","description":"\n\u003cp\u003eThis name that will appear in call logs.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ping_timeout_seconds","full_name":"ping_timeout_seconds","description":"\n\u003cp\u003eHow many seconds Trackdrive waits for this buyer’s ping to respond. Reading returns the largest timeout across the buyer’s ping settings; writing applies the value to all of them. Call routing waits for every ping to resolve, so the slowest buyer sets the caller’s hold time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_token_values","full_name":"current_conversion_token_values","description":"\n\u003cp\u003eConversion will only occur if the caller matches these filters.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_attribution_token_values","full_name":"current_conversion_attribution_token_values","description":"\n\u003cp\u003eIf the call converts, these tokens will be applied to the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ebuyer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ebuyer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"copy_another_buyer","full_name":"copy_another_buyer","description":"\n\u003cp\u003eCopy another buyer?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"copy_id","full_name":"copy_id","description":"\n\u003cp\u003eThe id of the buyer you would like to copy.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"user_buyer_id","full_name":"user_buyer_id","description":"\n\u003cp\u003eYour external ID for this buyer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number","full_name":"number","description":"\n\u003cp\u003eThe 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 ‘sip:’.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name for this buyer that will appear on menus and in logs.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timeout_seconds","full_name":"timeout_seconds","description":"\n\u003cp\u003eDetermines 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dtmf_tones","full_name":"dtmf_tones","description":"\n\u003cp\u003ePlay 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 ‘w’ characters. Each ‘w’ character waits 0.5 second before sending a digit. Each ‘W’ character waits 1 second before sending a digit.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_caller_name","full_name":"dial_caller_name","description":"\n\u003cp\u003eThe caller name announced to this buyer when the call connects, with tokens replaced before it is sent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delay_calling_buyer_seconds","full_name":"delay_calling_buyer_seconds","description":"\n\u003cp\u003eThe number of seconds Trackdrive waits before dialing this buyer after a call is ready to transfer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sip_username","full_name":"sip_username","description":"\n\u003cp\u003eThe SIP username used when dialing this buyer’s \u003ccode\u003esip:\u003c/code\u003e endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sip_password","full_name":"sip_password","description":"\n\u003cp\u003eThe SIP password used when dialing this buyer’s \u003ccode\u003esip:\u003c/code\u003e endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_platform_id","full_name":"external_platform_id","description":"\n\u003cp\u003eThe known third-party platform this buyer’s number or SIP endpoint belongs to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"buyer_fleet_id","full_name":"buyer_fleet_id","description":"\n\u003cp\u003eThe \u003ccode\u003eBuyerFleet\u003c/code\u003e this buyer is grouped under.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Buyer Fleet}[/api/docs/1.0/buyer_fleets/index.html]. Refer to: {/api/docs/1.0/buyer_fleets}[/api/docs/1.0/buyer_fleets/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_suppression_ids","full_name":"buyer_suppression_ids","description":"\n\u003cp\u003eThe list of internal suppression id’s that will be assigned to this buyer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eCallers will be routed to Buyers with matching tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eWhen this Buyer is connected to a Caller, the Call will be tagged with these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause the buyer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls","full_name":"record_calls","description":"\n\u003cp\u003eEnable or Disable call recordings for this Buyer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls_require_authorization","full_name":"record_calls_require_authorization","description":"\n\u003cp\u003eRequire a Trackdrive user logged into your company to have permission to download call recordings for calls transferred to this buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"press_one_to_accept","full_name":"press_one_to_accept","description":"\n\u003cp\u003eAfter answering the call the Buyer must Press 1 before being connected to the Caller.\u003cbr\u003e Trackdrive will use the “Press 1 To Accept” call routing from the current Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"generate_team","full_name":"generate_team","description":"\n\u003cp\u003eGrant access to edit this Buyer, and view calls that it paid for.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n\u003cp\u003eThe selected users will recieve an email invitation to collaborate on your company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: \u003ccode\u003e[\"john-smith@gmail.com\", \"example@domain.com\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n\u003cp\u003eTeam members can view calls made to these Offers that were paid for by their Buyer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"route_by_type","full_name":"route_by_type","description":"\n\u003cp\u003eConfigure 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etier\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003eepc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eWhen 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"epc_timeframe","full_name":"epc_timeframe","description":"\n\u003cp\u003eThe number of hours used when calculating the \u003ccode\u003eEPC\u003c/code\u003e. If there are less than \u003ccode\u003eMinimum Required Calls\u003c/code\u003e in this timeframe the \u003ccode\u003eAssumed EPC\u003c/code\u003e will be used instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"epc_assumed_amount","full_name":"epc_assumed_amount","description":"\n\u003cp\u003eThe \u003ccode\u003eAssumed EPC\u003c/code\u003e will be used until the Buyer has received \u003ccode\u003eMinimum Required Calls\u003c/code\u003e calls during the \u003ccode\u003eEPC Timeframe\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"epc_assumed_calls_count","full_name":"epc_assumed_calls_count","description":"\n\u003cp\u003eThe number of calls required during \u003ccode\u003eEPC Timeframe\u003c/code\u003e before the real \u003ccode\u003eEPC\u003c/code\u003e is used insead of the \u003ccode\u003eAssumed EPC\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weight","full_name":"weight","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_prematch_buyer_search","full_name":"use_with_prematch_buyer_search","description":"\n\u003cp\u003eInclude this buyer when Trackdrive searches for a matching buyer before a lead is matched to an offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_ping_before_calling_lead","full_name":"enable_ping_before_calling_lead","description":"\n\u003cp\u003ePing this buyer before calling the lead back, used with off-hook webhook conversions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_conversion_sync","full_name":"webhook_conversion_sync","description":"\n\u003cp\u003eWhen true, Trackdrive waits for this buyer’s webhook conversion ping to respond before pinging the next buyer, instead of pinging all webhook buyers at once.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ping_priority","full_name":"ping_priority","description":"\n\u003cp\u003eThe order this buyer is pinged in relative to other webhook buyers on the same offer. Lower numbers are pinged first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_dynamic_number","full_name":"use_dynamic_number","description":"\n\u003cp\u003eReplace this buyer’s \u003ccode\u003enumber\u003c/code\u003e with \u003ccode\u003edynamic_number\u003c/code\u003e, with its tokens replaced, when dialing this buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dynamic_number","full_name":"dynamic_number","description":"\n\u003cp\u003eThe token-replaced number or SIP address dialed instead of \u003ccode\u003enumber\u003c/code\u003e when \u003ccode\u003euse_dynamic_number\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_key_press_flows","full_name":"use_with_key_press_flows","description":"\n\u003cp\u003eApply a key press flow group to calls transferred to this buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group applied when \u003ccode\u003euse_with_key_press_flows\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_voicemail_sound_playlist_id","full_name":"record_voicemail_sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist played to a caller when this buyer leaves them a voicemail.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display_caller_id_type","full_name":"display_caller_id_type","description":"\n\u003cp\u003eSelect which Caller ID will be sent to this Buyer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edisplay_caller_id\u003c/code\u003e, \u003ccode\u003edisplay_fake_caller_id\u003c/code\u003e, \u003ccode\u003edisplay_trackdrive_number_id\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display_trackdrive_number_id","full_name":"display_trackdrive_number_id","description":"\n\u003cp\u003eThe Trackdrive number to display when display_caller_id_type=display_trackdrive_number_id\u003c/p\u003e\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":[],"deprecated":false},{"name":"concurrency_cap_limit","full_name":"concurrency_cap_limit","description":"\n\u003cp\u003eChoose the number of concurrent calls that can be forwarded to this buyer simultaneously.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"convert_when_downstream_converts","full_name":"convert_when_downstream_converts","description":"\n\u003cp\u003eConvert When Downstream Converts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_total_limit","full_name":"attempt_total_limit","description":"\n\u003cp\u003eAttempt caps limit the number of times a buyer can be attempted in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_monthly_limit","full_name":"attempt_monthly_limit","description":"\n\u003cp\u003eMonthly Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_daily_limit","full_name":"attempt_daily_limit","description":"\n\u003cp\u003eDaily Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attempt_hourly_limit","full_name":"attempt_hourly_limit","description":"\n\u003cp\u003eHourly Attempt Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_total_limit","full_name":"connection_total_limit","description":"\n\u003cp\u003eConnection caps limit the number of times a buyer can be connected in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_monthly_limit","full_name":"connection_monthly_limit","description":"\n\u003cp\u003eMonthly Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_daily_limit","full_name":"connection_daily_limit","description":"\n\u003cp\u003eDaily Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connection_hourly_limit","full_name":"connection_hourly_limit","description":"\n\u003cp\u003eHourly Connection Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_total_limit","full_name":"buyer_conversion_total_limit","description":"\n\u003cp\u003eConversion caps limit the number of times a buyer can convert in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_monthly_limit","full_name":"buyer_conversion_monthly_limit","description":"\n\u003cp\u003eMonthly Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_daily_limit","full_name":"buyer_conversion_daily_limit","description":"\n\u003cp\u003eDaily Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_hourly_limit","full_name":"buyer_conversion_hourly_limit","description":"\n\u003cp\u003eHourly Conversion Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_total_limit","full_name":"revenue_total_limit","description":"\n\u003cp\u003eRevenue caps limit the dollar amount that can be paid by a buyer in a given interval.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_monthly_limit","full_name":"revenue_monthly_limit","description":"\n\u003cp\u003eMonthly $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_daily_limit","full_name":"revenue_daily_limit","description":"\n\u003cp\u003eDaily $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_hourly_limit","full_name":"revenue_hourly_limit","description":"\n\u003cp\u003eHourly $ Revenue Cap\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_hours_schedule","full_name":"business_hours_schedule","description":"\n\u003cp\u003eDay is an integer representing the day of the week, 0..6, with Sunday == 0. [\u003c/p\u003e\n\n\u003cpre class=\"ruby\"\u003e{\n  \u003cspan class=\"ruby-value\"\u003eattempt_hourly_limit\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003econnection_hourly_limit\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003ebuyer_conversion_hourly_limit\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003erevenue_hourly_limit\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n  \u003cspan class=\"ruby-value\"\u003eschedule\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [\n    {\n      \u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e0\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e11:00..13:09\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e, \u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e14:00..15:09\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]\n    },\n    {\n      \u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e1\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e11:10..18:39\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e, \u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e19:10..23:39\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]\n    }\n  ]\n}\n\u003c/pre\u003e\n\n\u003cp\u003e]\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_conversions_schedule","full_name":"buyer_conversions_schedule","description":"\n\u003cp\u003eDay is an integer representing the day of the week, 0..6, with Sunday == 0. [\u003c/p\u003e\n\n\u003cpre class=\"ruby\"\u003e{\n  \u003cspan class=\"ruby-value\"\u003ebuyer_conversions_attributes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [\n    {\n      \u003cspan class=\"ruby-value\"\u003ename\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-string\"\u003e\u0026#39;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e10$ conversion at 1 minute, deduped every 2 hours\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026#39;\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003eduration\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e60\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003erevenue\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e10\u003c/span\u003e,\n      \u003cspan class=\"ruby-value\"\u003eduplicate_timeframe\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e \u003cspan class=\"ruby-value\"\u003e7200\u003c/span\u003e\n    }\n  ],\n  \u003cspan class=\"ruby-value\"\u003eschedule\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e:\u003c/span\u003e [{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e0\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e1\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e2\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e3\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e4\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e5\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]},{\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003eday\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e6\u003c/span\u003e,\u003cspan class=\"ruby-value\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003etimes\u003c/span\u003e\u003cspan class=\"ruby-value\"\u003e\u0026quot;:\u003c/span\u003e[\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e00:00..23:59\u003c/span\u003e\u003cspan class=\"ruby-string\"\u003e\u0026quot;\u003c/span\u003e]}]\n}\n\u003c/pre\u003e\n\n\u003cp\u003e]\u003c/p\u003e\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":[],"deprecated":false},{"name":"current_conversion_revenue_max","full_name":"current_conversion_revenue_max","description":"\n\u003cp\u003eThe maximum valid revenue for the current time frame.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_revenue_min","full_name":"current_conversion_revenue_min","description":"\n\u003cp\u003eThe minimum valid revenue for the current time frame.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_revenue_increment","full_name":"current_conversion_revenue_increment","description":"\n\u003cp\u003eBids must be increased/decreased by this amount for the current time frame.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_revenue","full_name":"current_conversion_revenue","description":"\n\u003cp\u003eThe number of dollars paid per call in increments of $0.01 for the current time frame.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_duration","full_name":"current_conversion_duration","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_duplicate_timeframe","full_name":"current_conversion_duplicate_timeframe","description":"\n\u003cp\u003eThe period of time that must elapse before a buyer will pay for the same caller to be transferred.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_name","full_name":"current_conversion_name","description":"\n\u003cp\u003eThis name that will appear in call logs.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ping_timeout_seconds","full_name":"ping_timeout_seconds","description":"\n\u003cp\u003eHow many seconds Trackdrive waits for this buyer’s ping to respond. Reading returns the largest timeout across the buyer’s ping settings; writing applies the value to all of them. Call routing waits for every ping to resolve, so the slowest buyer sets the caller’s hold time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_token_values","full_name":"current_conversion_token_values","description":"\n\u003cp\u003eConversion will only occur if the caller matches these filters.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_attribution_token_values","full_name":"current_conversion_attribution_token_values","description":"\n\u003cp\u003eIf the call converts, these tokens will be applied to the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"Delete a buyer with Trackdrive's internal ID.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ebuyer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"A group of agents who share softphone settings and can be assigned to handle calls together.","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\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_call_center_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsoftphone_host\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_call_center_id","full_name":"user_call_center_id","description":"\n\u003cp\u003eYour external ID for this call center.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this call center, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThe ids of the Token Values whose tokens will be additionally applied to calls handled by this call center.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_call_center_id","full_name":"user_call_center_id","description":"\n\u003cp\u003eYour external ID for this call center.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this call center, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThe ids of the Token Values whose tokens will be additionally applied to calls handled by this call center.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_call_center_id","full_name":"user_call_center_id","description":"\n\u003cp\u003eYour external ID for this call center.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this call center, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThe ids of the Token Values whose tokens will be additionally applied to calls handled by this call center.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"A customizable button agents can click during a call to trigger routing, tagging, or other in-call actions.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsystem_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackground_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfont_size\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_shadow_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequire_live_caller\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncss_styles\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_actions_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nopen_link_on_click\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nopen_link_on_click_href\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_params_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwhisper_sound_playlist_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwhisper_sound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwhisper_sound_playlist_target\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_to_speech\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstop_whisper_sound_playlist\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_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\u003cp\u003eSystem Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eText Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eBackground Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eFont Size\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eText Shadow Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eFilter Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this Call Action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_live_caller","full_name":"require_live_caller","description":"\n\u003cp\u003eWhen enabled, this action is only available while the caller is still on the line.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click","full_name":"open_link_on_click","description":"\n\u003cp\u003eWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click_href","full_name":"open_link_on_click_href","description":"\n\u003cp\u003eThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003eHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_enabled","full_name":"whisper_sound_playlist_enabled","description":"\n\u003cp\u003eWhen enabled, plays a whisper message when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_id","full_name":"whisper_sound_playlist_id","description":"\n\u003cp\u003eThe Sound Playlist to whisper from, used when message_type is not speak.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_target","full_name":"whisper_sound_playlist_target","description":"\n\u003cp\u003eWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stop_whisper_sound_playlist","full_name":"stop_whisper_sound_playlist","description":"\n\u003cp\u003eWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eSystem Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eText Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eBackground Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eFont Size\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eText Shadow Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eFilter Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this Call Action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_live_caller","full_name":"require_live_caller","description":"\n\u003cp\u003eWhen enabled, this action is only available while the caller is still on the line.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click","full_name":"open_link_on_click","description":"\n\u003cp\u003eWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click_href","full_name":"open_link_on_click_href","description":"\n\u003cp\u003eThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003eHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_enabled","full_name":"whisper_sound_playlist_enabled","description":"\n\u003cp\u003eWhen enabled, plays a whisper message when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_id","full_name":"whisper_sound_playlist_id","description":"\n\u003cp\u003eThe Sound Playlist to whisper from, used when message_type is not speak.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_target","full_name":"whisper_sound_playlist_target","description":"\n\u003cp\u003eWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stop_whisper_sound_playlist","full_name":"stop_whisper_sound_playlist","description":"\n\u003cp\u003eWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eSystem Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eText Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eBackground Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eFont Size\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eText Shadow Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eFilter Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this Call Action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_live_caller","full_name":"require_live_caller","description":"\n\u003cp\u003eWhen enabled, this action is only available while the caller is still on the line.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click","full_name":"open_link_on_click","description":"\n\u003cp\u003eWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click_href","full_name":"open_link_on_click_href","description":"\n\u003cp\u003eThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003eHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_enabled","full_name":"whisper_sound_playlist_enabled","description":"\n\u003cp\u003eWhen enabled, plays a whisper message when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_id","full_name":"whisper_sound_playlist_id","description":"\n\u003cp\u003eThe Sound Playlist to whisper from, used when message_type is not speak.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_target","full_name":"whisper_sound_playlist_target","description":"\n\u003cp\u003eWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stop_whisper_sound_playlist","full_name":"stop_whisper_sound_playlist","description":"\n\u003cp\u003eWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Custom outcome codes agents assign to calls that control routing, reporting, and agent workflow behavior.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_dispositions/index","name":"index","apis":[{"api_url":"/api/v1/call_dispositions","http_method":"GET","short_description":"List Call Disposition records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhint\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_on_agent_widget\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_in_tables\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_in_reports\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_call_answered\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_agent_handled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_buyer_handled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_qualified\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_callback_now\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_end_of_schedule\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_block_caller\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_auto_next_lead\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnotes_required\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfont_size\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_shadow_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackground_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nline_height\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_action_leave_voicemail\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_action_apply_opt_out\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsystem_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_when_blank\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_machine_detected\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_disposition_action_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nreuse_conference\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_add_to_schedule_suppression\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndelete_scheduled_callbacks\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscheduled_callback_chance\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/new","name":"new","apis":[{"api_url":"/api/v1/call_dispositions/new","http_method":"GET","short_description":"Build Call Disposition with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n\u003cp\u003eShow this disposition on the agent widget?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShow this disposition as a column on tables?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShow this disposition as a column on reports?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n\u003cp\u003eMark the call as having been answered?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n\u003cp\u003eMark the call as having been handled by an agent?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n\u003cp\u003eMark the call as having been handled by a buyer?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n\u003cp\u003eMark the call as having been qualified?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n\u003cp\u003eTrigger the end of schedule when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n\u003cp\u003eBlock the caller when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n\u003cp\u003eAutomatically move to the next lead after selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes_required","full_name":"notes_required","description":"\n\u003cp\u003eRequire the agent to write notes about this call?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_leave_voicemail","full_name":"call_action_leave_voicemail","description":"\n\u003cp\u003eWhen enabled, applying this disposition plays a recorded voicemail message to the caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_apply_opt_out","full_name":"call_action_apply_opt_out","description":"\n\u003cp\u003eWhen enabled, applying this disposition opts the caller out of future contact.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_machine_detected","full_name":"apply_machine_detected","description":"\n\u003cp\u003eWhen enabled, applying this disposition marks the call as having reached an answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_add_to_schedule_suppression","full_name":"apply_add_to_schedule_suppression","description":"\n\u003cp\u003eWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reuse_conference","full_name":"reuse_conference","description":"\n\u003cp\u003eWhen enabled, applying this disposition keeps the existing conference open instead of ending it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_scheduled_callbacks","full_name":"delete_scheduled_callbacks","description":"\n\u003cp\u003eWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_now","full_name":"schedule_callback_now","description":"\n\u003cp\u003eWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_chance","full_name":"scheduled_callback_chance","description":"\n\u003cp\u003eThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_blank","full_name":"use_when_blank","description":"\n\u003cp\u003eWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule whose actions run when this disposition is applied to a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button background, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text shadow, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eApply these additional tokens to the call when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_token_value_ids","full_name":"filter_token_value_ids","description":"\n\u003cp\u003eOnly show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/create","name":"create","apis":[{"api_url":"/api/v1/call_dispositions","http_method":"POST","short_description":"Create Call Disposition.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n\u003cp\u003eShow this disposition on the agent widget?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShow this disposition as a column on tables?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShow this disposition as a column on reports?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n\u003cp\u003eMark the call as having been answered?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n\u003cp\u003eMark the call as having been handled by an agent?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n\u003cp\u003eMark the call as having been handled by a buyer?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n\u003cp\u003eMark the call as having been qualified?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n\u003cp\u003eTrigger the end of schedule when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n\u003cp\u003eBlock the caller when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n\u003cp\u003eAutomatically move to the next lead after selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes_required","full_name":"notes_required","description":"\n\u003cp\u003eRequire the agent to write notes about this call?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_leave_voicemail","full_name":"call_action_leave_voicemail","description":"\n\u003cp\u003eWhen enabled, applying this disposition plays a recorded voicemail message to the caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_apply_opt_out","full_name":"call_action_apply_opt_out","description":"\n\u003cp\u003eWhen enabled, applying this disposition opts the caller out of future contact.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_machine_detected","full_name":"apply_machine_detected","description":"\n\u003cp\u003eWhen enabled, applying this disposition marks the call as having reached an answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_add_to_schedule_suppression","full_name":"apply_add_to_schedule_suppression","description":"\n\u003cp\u003eWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reuse_conference","full_name":"reuse_conference","description":"\n\u003cp\u003eWhen enabled, applying this disposition keeps the existing conference open instead of ending it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_scheduled_callbacks","full_name":"delete_scheduled_callbacks","description":"\n\u003cp\u003eWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_now","full_name":"schedule_callback_now","description":"\n\u003cp\u003eWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_chance","full_name":"scheduled_callback_chance","description":"\n\u003cp\u003eThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_blank","full_name":"use_when_blank","description":"\n\u003cp\u003eWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule whose actions run when this disposition is applied to a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button background, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text shadow, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eApply these additional tokens to the call when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_token_value_ids","full_name":"filter_token_value_ids","description":"\n\u003cp\u003eOnly show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/show","name":"show","apis":[{"api_url":"/api/v1/call_dispositions/:id","http_method":"GET","short_description":"Get Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/update","name":"update","apis":[{"api_url":"/api/v1/call_dispositions/:id","http_method":"PUT","short_description":"Update Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_agent_widget","full_name":"show_on_agent_widget","description":"\n\u003cp\u003eShow this disposition on the agent widget?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShow this disposition as a column on tables?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShow this disposition as a column on reports?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_call_answered","full_name":"apply_call_answered","description":"\n\u003cp\u003eMark the call as having been answered?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_agent_handled","full_name":"apply_agent_handled","description":"\n\u003cp\u003eMark the call as having been handled by an agent?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_buyer_handled","full_name":"apply_buyer_handled","description":"\n\u003cp\u003eMark the call as having been handled by a buyer?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_qualified","full_name":"apply_qualified","description":"\n\u003cp\u003eMark the call as having been qualified?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_end_of_schedule","full_name":"apply_end_of_schedule","description":"\n\u003cp\u003eTrigger the end of schedule when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_caller","full_name":"apply_block_caller","description":"\n\u003cp\u003eBlock the caller when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_auto_next_lead","full_name":"apply_auto_next_lead","description":"\n\u003cp\u003eAutomatically move to the next lead after selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notes_required","full_name":"notes_required","description":"\n\u003cp\u003eRequire the agent to write notes about this call?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_leave_voicemail","full_name":"call_action_leave_voicemail","description":"\n\u003cp\u003eWhen enabled, applying this disposition plays a recorded voicemail message to the caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_action_apply_opt_out","full_name":"call_action_apply_opt_out","description":"\n\u003cp\u003eWhen enabled, applying this disposition opts the caller out of future contact.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_machine_detected","full_name":"apply_machine_detected","description":"\n\u003cp\u003eWhen enabled, applying this disposition marks the call as having reached an answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_add_to_schedule_suppression","full_name":"apply_add_to_schedule_suppression","description":"\n\u003cp\u003eWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reuse_conference","full_name":"reuse_conference","description":"\n\u003cp\u003eWhen enabled, applying this disposition keeps the existing conference open instead of ending it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_scheduled_callbacks","full_name":"delete_scheduled_callbacks","description":"\n\u003cp\u003eWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_now","full_name":"schedule_callback_now","description":"\n\u003cp\u003eWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_chance","full_name":"scheduled_callback_chance","description":"\n\u003cp\u003eThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_blank","full_name":"use_when_blank","description":"\n\u003cp\u003eWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule whose actions run when this disposition is applied to a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button background, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eThe hex color of this disposition’s button text shadow, e.g.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eApply these additional tokens to the call when selecting this disposition?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_token_value_ids","full_name":"filter_token_value_ids","description":"\n\u003cp\u003eOnly show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_dispositions/:id","http_method":"DELETE","short_description":"Destroy Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_logs":{"doc_url":"/api/docs/1.0/call_logs","id":"call_logs","api_url":"/api","name":"Call 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\u003cp\u003eThe internal id for a call on Trackdrive.\u003c/p\u003e\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":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"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":"Rules that automatically delete call recordings after a set retention period, scoped to an offer, schedule, buyer, or traffic source.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecording_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nretention_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompleted_at\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recording_type","full_name":"recording_type","description":"\n\u003cp\u003eThis type of recording will be deleted once the retention period has passed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecall\u003c/code\u003e, \u003ccode\u003econsumer_and_agent\u003c/code\u003e, \u003ccode\u003econsumer_and_buyer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retention_seconds","full_name":"retention_seconds","description":"\n\u003cp\u003eIf a recording is older than this many seconds, it will be deleted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOnly recordings matching this offer will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eOnly recordings matching this Schedule will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eOnly recordings matching this Buyer will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eOnly recordings matching this Traffic Source will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recording_type","full_name":"recording_type","description":"\n\u003cp\u003eThis type of recording will be deleted once the retention period has passed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecall\u003c/code\u003e, \u003ccode\u003econsumer_and_agent\u003c/code\u003e, \u003ccode\u003econsumer_and_buyer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retention_seconds","full_name":"retention_seconds","description":"\n\u003cp\u003eIf a recording is older than this many seconds, it will be deleted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOnly recordings matching this offer will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eOnly recordings matching this Schedule will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eOnly recordings matching this Buyer will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eOnly recordings matching this Traffic Source will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recording_type","full_name":"recording_type","description":"\n\u003cp\u003eThis type of recording will be deleted once the retention period has passed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecall\u003c/code\u003e, \u003ccode\u003econsumer_and_agent\u003c/code\u003e, \u003ccode\u003econsumer_and_buyer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retention_seconds","full_name":"retention_seconds","description":"\n\u003cp\u003eIf a recording is older than this many seconds, it will be deleted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOnly recordings matching this offer will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eOnly recordings matching this Schedule will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eOnly recordings matching this Buyer will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eOnly recordings matching this Traffic Source will be deleted after the retention period.\u003c/p\u003e\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":[],"deprecated":false}],"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":"Groups of keypress choices offered to callers during an IVR menu, with shared response-collection settings.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_answers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_answer_with_pound\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_answer_without_pound\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nanswer_length_min\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nanswer_length_max\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nanswer_length_timeout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nanswer_assign_to_token_key\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_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\u003cp\u003eName of the Answer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eOptional description for the Answer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\n\u003cp\u003eNumber of single-key answers configured in this group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_answer_with_pound","full_name":"request_answer_with_pound","description":"\n\u003cp\u003eCollect a multi-digit response and require callers to press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_min","full_name":"answer_length_min","description":"\n\u003cp\u003eMinimum number of digits expected when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_max","full_name":"answer_length_max","description":"\n\u003cp\u003eMaximum number of digits allowed when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_timeout","full_name":"answer_length_timeout","description":"\n\u003cp\u003eSeconds to wait for input before timing out when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_assign_to_token_key","full_name":"answer_assign_to_token_key","description":"\n\u003cp\u003eThe token key the caller’s entered digits are saved to when collecting a multi-digit response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName of the Answer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eOptional description for the Answer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\n\u003cp\u003eNumber of single-key answers configured in this group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_answer_with_pound","full_name":"request_answer_with_pound","description":"\n\u003cp\u003eCollect a multi-digit response and require callers to press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_min","full_name":"answer_length_min","description":"\n\u003cp\u003eMinimum number of digits expected when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_max","full_name":"answer_length_max","description":"\n\u003cp\u003eMaximum number of digits allowed when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_timeout","full_name":"answer_length_timeout","description":"\n\u003cp\u003eSeconds to wait for input before timing out when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_assign_to_token_key","full_name":"answer_assign_to_token_key","description":"\n\u003cp\u003eThe token key the caller’s entered digits are saved to when collecting a multi-digit response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName of the Answer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eOptional description for the Answer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\n\u003cp\u003eNumber of single-key answers configured in this group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_answer_with_pound","full_name":"request_answer_with_pound","description":"\n\u003cp\u003eCollect a multi-digit response and require callers to press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_min","full_name":"answer_length_min","description":"\n\u003cp\u003eMinimum number of digits expected when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_max","full_name":"answer_length_max","description":"\n\u003cp\u003eMaximum number of digits allowed when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_length_timeout","full_name":"answer_length_timeout","description":"\n\u003cp\u003eSeconds to wait for input before timing out when collecting a numeric response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"answer_assign_to_token_key","full_name":"answer_assign_to_token_key","description":"\n\u003cp\u003eThe token key the caller’s entered digits are saved to when collecting a multi-digit response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"A single keypress option within an IVR menu, defining what happens when a caller presses that key.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_answer_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey_press\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_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\u003cp\u003eAnswer Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press","full_name":"key_press","description":"\n\u003cp\u003eKey Press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eFilters\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eThis answer will only be used for calls matching these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eAdditional Tokens\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThese extra tokens will be applied to calls that use this answer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAnswer Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press","full_name":"key_press","description":"\n\u003cp\u003eKey Press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eFilters\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eThis answer will only be used for calls matching these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eAdditional Tokens\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThese extra tokens will be applied to calls that use this answer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAnswer Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press","full_name":"key_press","description":"\n\u003cp\u003eKey Press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eFilters\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eThis answer will only be used for calls matching these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eAdditional Tokens\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThese extra tokens will be applied to calls that use this answer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Individual rules in an offer's call flow controlling greetings, IVR menus, dialing, hold queues and exception 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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncategory\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_loop\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_to_speech\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_to_speech_gender\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrouter_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_option\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_offer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutbound_timeout_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrouter_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_action_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey_press_timeout_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nperform_action_if_buyer_is_available\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninbound_call_route_async\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackup_buyer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackup_buyer_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_sound_playlist\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_music_sound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvoicemail_sound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_schedule\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_extension_pool\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nallows_outgoing_webhooks\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_with_find_a_buyer\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_with_key_press_flows\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey_press_flow_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nauto_retry_next_buyer\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nauto_retry_next_buyer_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_extension_actions\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_schedule_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncan_dial\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncan_alter_traffic_source\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_call_disposition_wait_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_queue_caller_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_queue_percentage_size\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_hold_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_hold_seconds_average\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfire_call_router_webhooks_before_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_digit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_calls_per_seat\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_unaccepted_wait\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_leads_needed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naudio_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvoicemail_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_music_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_hangup_reason\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_answer_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_no_lead_timeout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nafter_action_sound_playlist_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nafter_action_sound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_dropped_call_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_drop_limit_1\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_drop_cps_1\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_drop_limit_2\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_drop_cps_2\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_buyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_buyer_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_buyer_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_dropped_calls\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_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\u003cp\u003ePlay A Message?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eNo Message\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003espeak\u003c/th\u003e\u003ctd\u003eSpeak TTS\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaudio\u003c/th\u003e\u003ctd\u003ePlay Audio\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"router_action","full_name":"router_action","description":"\n\u003cp\u003eChoose An Action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003edial\u003c/th\u003e\u003ctd\u003eForward To Buyers or Agents\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eredirect\u003c/th\u003e\u003ctd\u003eForward To Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_schedule\u003c/th\u003e\u003ctd\u003eAdd To Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_hold_queue\u003c/th\u003e\u003ctd\u003ePlace Caller In Hold Queue\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eremove_from_schedule\u003c/th\u003e\u003ctd\u003eRemove From Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erecord_voicemail\u003c/th\u003e\u003ctd\u003eRecord Voicemail\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erequest_key_press\u003c/th\u003e\u003ctd\u003eRequest Key Press\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eblock_caller\u003c/th\u003e\u003ctd\u003eBlock Caller\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eend_call\u003c/th\u003e\u003ctd\u003eHang Up\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eContinue Offer Routing\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribe the purpose of this call flow rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eText To Speech that will be spoken when \u003ccode\u003emessage_type=speak\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_loop","full_name":"message_loop","description":"\n\u003cp\u003eThe message will be repeated this many times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eThe audio file that will be played when \u003ccode\u003emessage_type=audio\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule that will be used when \u003ccode\u003erouter_action=add_to_schedule\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyers when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyer groups when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n\u003cp\u003eCalls will be forwarded to this offer when \u003ccode\u003erouter_action=redirect\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. How many people can be on hold?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Set the hold queue size automatically by taking [Active CC * This Percentage]\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Maximum number of seconds a caller can be on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA short label for this call flow rule shown in the call flow list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_action_type","full_name":"message_action_type","description":"\n\u003cp\u003eThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech_gender","full_name":"text_to_speech_gender","description":"\n\u003cp\u003eThe voice used for the \u003ccode\u003etext_to_speech\u003c/code\u003e message, \u003ccode\u003eMale\u003c/code\u003e or \u003ccode\u003eFemale\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_timeout_seconds","full_name":"key_press_timeout_seconds","description":"\n\u003cp\u003eHow many seconds to wait for a key press before continuing when \u003ccode\u003erouter_type=press_1_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_type","full_name":"traffic_source_action_type","description":"\n\u003cp\u003eHow the traffic source should be altered when this rule runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_id","full_name":"traffic_source_action_id","description":"\n\u003cp\u003eThe traffic source to assign when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e reassigns the traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"traffic_source_action_payout","full_name":"traffic_source_action_payout","description":"\n\u003cp\u003eThe alternate payout applied when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e sets a new payout.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outbound_timeout_seconds","full_name":"outbound_timeout_seconds","description":"\n\u003cp\u003eHow many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_find_a_buyer","full_name":"use_with_find_a_buyer","description":"\n\u003cp\u003eOnly perform this action when a buyer can be matched for the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"perform_action_if_buyer_is_available","full_name":"perform_action_if_buyer_is_available","description":"\n\u003cp\u003eOnly perform this action when a buyer is available. Companion setting to \u003ccode\u003euse_with_find_a_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_retry_next_buyer","full_name":"auto_retry_next_buyer","description":"\n\u003cp\u003eAutomatically dial the next buyer if the current one does not answer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_retry_next_buyer_seconds","full_name":"auto_retry_next_buyer_seconds","description":"\n\u003cp\u003eHow many seconds to wait before dialing the next buyer when \u003ccode\u003eauto_retry_next_buyer\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_call_route_async","full_name":"inbound_call_route_async","description":"\n\u003cp\u003eRoute the inbound call asynchronously instead of holding the caller while this rule runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_no_lead_timeout","full_name":"off_hook_no_lead_timeout","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent can go without a matching lead before instant agent dialing stops.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_calls_per_seat","full_name":"off_hook_calls_per_seat","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many outbound calls to place per available agent seat.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_unaccepted_wait","full_name":"off_hook_unaccepted_wait","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent has to accept an offered call before it is considered unaccepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_leads_needed","full_name":"off_hook_leads_needed","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many matching leads must be available before dialing an agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_dropped_call_seconds","full_name":"off_hook_dropped_call_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The lookback window, in seconds, used to calculate the dropped call percentage.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_1","full_name":"off_hook_drop_limit_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The first dropped call percentage threshold that throttles outbound dialing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_1","full_name":"off_hook_drop_cps_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_1\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_2","full_name":"off_hook_drop_limit_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The second, higher dropped call percentage threshold that throttles outbound dialing further.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_2","full_name":"off_hook_drop_cps_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_2\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_digit","full_name":"action_digit","description":"\n\u003cp\u003eOnly perform this action if the caller pressed this key.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_call_disposition_wait_seconds","full_name":"max_call_disposition_wait_seconds","description":"\n\u003cp\u003eHow many seconds to wait for an agent to disposition a call before moving on.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_hangup_reason","full_name":"call_router_hangup_reason","description":"\n\u003cp\u003eThe reason recorded on the call when this rule hangs up the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fire_call_router_webhooks_before_action","full_name":"fire_call_router_webhooks_before_action","description":"\n\u003cp\u003eFire this rule’s outgoing webhooks before performing its action instead of after.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_ids","full_name":"backup_buyer_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow agents dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow buyer groups dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e/\u003ccode\u003ebuyer_group_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_file","full_name":"voicemail_file","description":"\n\u003cp\u003eThe audio file an instant agent can play to a lead’s answering machine when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_voicemail_file","full_name":"remove_voicemail_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003evoicemail_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_music_file","full_name":"hold_music_file","description":"\n\u003cp\u003eCustom music played to an instant agent while on hold when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Falls back to the default hold music when blank.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_hold_music_file","full_name":"remove_hold_music_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003ehold_music_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group used to process the caller’s key press response for this rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_sound_playlist","full_name":"use_sound_playlist","description":"\n\u003cp\u003ePlay a random file from a sound playlist instead of a single uploaded \u003ccode\u003eaudio_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sound_playlist_id","full_name":"sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist to play from when \u003ccode\u003euse_sound_playlist\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_music_sound_playlist_id","full_name":"hold_music_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist played to an instant agent while on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"voicemail_sound_playlist_id","full_name":"voicemail_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist an instant agent can play to a lead’s answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"after_action_sound_playlist_enabled","full_name":"after_action_sound_playlist_enabled","description":"\n\u003cp\u003ePlay a sound playlist after this rule’s action completes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"after_action_sound_playlist_id","full_name":"after_action_sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist played after this rule’s action completes, when \u003ccode\u003eafter_action_sound_playlist_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"router_type","full_name":"router_type","description":"\n\u003cp\u003eThe type of Call Flow Rule.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eask_a_question\u003c/th\u003e\u003ctd\u003eAsk A Question And Request An Answer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_greeting_is_played\u003c/th\u003e\u003ctd\u003eHandle Call When No Keypress Is Requested\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econnect_ai_voice_agent\u003c/th\u003e\u003ctd\u003eConnect AI Voice Agent\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewhen_answering_machine_detected\u003c/th\u003e\u003ctd\u003eWhen an answering machine is detected\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebefore_answering_machine_detected\u003c/th\u003e\u003ctd\u003eBefore an answering machine is detected\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003egreeting\u003c/th\u003e\u003ctd\u003ePlay A Greeting Message And Request A Keypress\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoff_hook_press_to_accept\u003c/th\u003e\u003ctd\u003eWhen Getting Instant Agents On The Phone\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_1\u003c/th\u003e\u003ctd\u003eWhen 1 is Pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_2\u003c/th\u003e\u003ctd\u003eWhen 2 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_3\u003c/th\u003e\u003ctd\u003eWhen 3 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_4\u003c/th\u003e\u003ctd\u003eWhen 4 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_5\u003c/th\u003e\u003ctd\u003eWhen 5 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_6\u003c/th\u003e\u003ctd\u003eWhen 6 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_7\u003c/th\u003e\u003ctd\u003eWhen 7 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_8\u003c/th\u003e\u003ctd\u003eWhen 8 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_9\u003c/th\u003e\u003ctd\u003eWhen 9 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_#\u003c/th\u003e\u003ctd\u003eWhen # is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_*\u003c/th\u003e\u003ctd\u003eWhen * is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_0\u003c/th\u003e\u003ctd\u003eWhen 0 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_key_press\u003c/th\u003e\u003ctd\u003eWhen nothing is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eany_other_key_press\u003c/th\u003e\u003ctd\u003eWhen anything is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecalling_buyer_music\u003c/th\u003e\u003ctd\u003eCalling Buyer Music Played to Caller during Transfers\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewhisper\u003c/th\u003e\u003ctd\u003eWhisper To Buyer that a Call is being Transferred\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eenter_extension\u003c/th\u003e\u003ctd\u003eEnter Extension\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eextension_failed\u003c/th\u003e\u003ctd\u003eWhen an invalid extension is entered\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_code_entry\u003c/th\u003e\u003ctd\u003eEnter Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_entry_failed\u003c/th\u003e\u003ctd\u003eIncorrect Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003epress_1_to_accept\u003c/th\u003e\u003ctd\u003eWhisper to Buyer to Press 1 to Accept a Call\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003epress_1_too_slow\u003c/th\u003e\u003ctd\u003eWhisper to Buyer that they Pressed 1 Too Slowly\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_hold_queue\u003c/th\u003e\u003ctd\u003eWhen placed in hold queue\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ehold_queue_is_full\u003c/th\u003e\u003ctd\u003eWhen the hold queue is full\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ehold_queue_max_seconds_exceeded\u003c/th\u003e\u003ctd\u003eWhen the caller has been on hold for longer than max hold seconds\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_instant_agent_available\u003c/th\u003e\u003ctd\u003eWhen no instant agent is available during an inbound call from a consumer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_instant_agent_available_outbound\u003c/th\u003e\u003ctd\u003eWhen no instant agent is available during an outbound call to a consumer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewhen_instant_agent_transfers_to_buyer\u003c/th\u003e\u003ctd\u003eWhen an instant agent transfers to a buyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewhen_buyer_hangup_before_duration\u003c/th\u003e\u003ctd\u003eWhen A Buyer Hangs Up Before Duration\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_buyers_have_open_concurrency_cap\u003c/th\u003e\u003ctd\u003eWhen no buyers have open concurrency cap\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eall_buyers_closed\u003c/th\u003e\u003ctd\u003eWhen no buyers are open\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_buyer_answered\u003c/th\u003e\u003ctd\u003eWhen no buyers answer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_buyers_match\u003c/th\u003e\u003ctd\u003eWhen no buyers have matching filters\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etag_validation_failed\u003c/th\u003e\u003ctd\u003eToken Entry Failed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etraffic_source_capped\u003c/th\u003e\u003ctd\u003eWhen the traffic source is capped\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecaller_hang_up_before_conference\u003c/th\u003e\u003ctd\u003eWhen the caller hangs up before being connected to a buyer\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003ePlay A Message?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eNo Message\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003espeak\u003c/th\u003e\u003ctd\u003eSpeak TTS\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaudio\u003c/th\u003e\u003ctd\u003ePlay Audio\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"router_action","full_name":"router_action","description":"\n\u003cp\u003eChoose An Action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003edial\u003c/th\u003e\u003ctd\u003eForward To Buyers or Agents\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eredirect\u003c/th\u003e\u003ctd\u003eForward To Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_schedule\u003c/th\u003e\u003ctd\u003eAdd To Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_hold_queue\u003c/th\u003e\u003ctd\u003ePlace Caller In Hold Queue\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eremove_from_schedule\u003c/th\u003e\u003ctd\u003eRemove From Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erecord_voicemail\u003c/th\u003e\u003ctd\u003eRecord Voicemail\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erequest_key_press\u003c/th\u003e\u003ctd\u003eRequest Key Press\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eblock_caller\u003c/th\u003e\u003ctd\u003eBlock Caller\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eend_call\u003c/th\u003e\u003ctd\u003eHang Up\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eContinue Offer Routing\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribe the purpose of this call flow rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eText To Speech that will be spoken when \u003ccode\u003emessage_type=speak\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_loop","full_name":"message_loop","description":"\n\u003cp\u003eThe message will be repeated this many times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eThe audio file that will be played when \u003ccode\u003emessage_type=audio\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule that will be used when \u003ccode\u003erouter_action=add_to_schedule\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyers when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyer groups when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n\u003cp\u003eCalls will be forwarded to this offer when \u003ccode\u003erouter_action=redirect\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. How many people can be on hold?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Set the hold queue size automatically by taking [Active CC * This Percentage]\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Maximum number of seconds a caller can be on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA short label for this call flow rule shown in the call flow list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_action_type","full_name":"message_action_type","description":"\n\u003cp\u003eThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech_gender","full_name":"text_to_speech_gender","description":"\n\u003cp\u003eThe voice used for the \u003ccode\u003etext_to_speech\u003c/code\u003e message, \u003ccode\u003eMale\u003c/code\u003e or \u003ccode\u003eFemale\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_timeout_seconds","full_name":"key_press_timeout_seconds","description":"\n\u003cp\u003eHow many seconds to wait for a key press before continuing when \u003ccode\u003erouter_type=press_1_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_type","full_name":"traffic_source_action_type","description":"\n\u003cp\u003eHow the traffic source should be altered when this rule runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_id","full_name":"traffic_source_action_id","description":"\n\u003cp\u003eThe traffic source to assign when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e reassigns the traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"traffic_source_action_payout","full_name":"traffic_source_action_payout","description":"\n\u003cp\u003eThe alternate payout applied when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e sets a new payout.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outbound_timeout_seconds","full_name":"outbound_timeout_seconds","description":"\n\u003cp\u003eHow many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_find_a_buyer","full_name":"use_with_find_a_buyer","description":"\n\u003cp\u003eOnly perform this action when a buyer can be matched for the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"perform_action_if_buyer_is_available","full_name":"perform_action_if_buyer_is_available","description":"\n\u003cp\u003eOnly perform this action when a buyer is available. Companion setting to \u003ccode\u003euse_with_find_a_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_retry_next_buyer","full_name":"auto_retry_next_buyer","description":"\n\u003cp\u003eAutomatically dial the next buyer if the current one does not answer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_retry_next_buyer_seconds","full_name":"auto_retry_next_buyer_seconds","description":"\n\u003cp\u003eHow many seconds to wait before dialing the next buyer when \u003ccode\u003eauto_retry_next_buyer\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_call_route_async","full_name":"inbound_call_route_async","description":"\n\u003cp\u003eRoute the inbound call asynchronously instead of holding the caller while this rule runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_no_lead_timeout","full_name":"off_hook_no_lead_timeout","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent can go without a matching lead before instant agent dialing stops.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_calls_per_seat","full_name":"off_hook_calls_per_seat","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many outbound calls to place per available agent seat.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_unaccepted_wait","full_name":"off_hook_unaccepted_wait","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent has to accept an offered call before it is considered unaccepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_leads_needed","full_name":"off_hook_leads_needed","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many matching leads must be available before dialing an agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_dropped_call_seconds","full_name":"off_hook_dropped_call_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The lookback window, in seconds, used to calculate the dropped call percentage.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_1","full_name":"off_hook_drop_limit_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The first dropped call percentage threshold that throttles outbound dialing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_1","full_name":"off_hook_drop_cps_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_1\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_2","full_name":"off_hook_drop_limit_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The second, higher dropped call percentage threshold that throttles outbound dialing further.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_2","full_name":"off_hook_drop_cps_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_2\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_digit","full_name":"action_digit","description":"\n\u003cp\u003eOnly perform this action if the caller pressed this key.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_call_disposition_wait_seconds","full_name":"max_call_disposition_wait_seconds","description":"\n\u003cp\u003eHow many seconds to wait for an agent to disposition a call before moving on.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_hangup_reason","full_name":"call_router_hangup_reason","description":"\n\u003cp\u003eThe reason recorded on the call when this rule hangs up the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fire_call_router_webhooks_before_action","full_name":"fire_call_router_webhooks_before_action","description":"\n\u003cp\u003eFire this rule’s outgoing webhooks before performing its action instead of after.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_ids","full_name":"backup_buyer_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow agents dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow buyer groups dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e/\u003ccode\u003ebuyer_group_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_file","full_name":"voicemail_file","description":"\n\u003cp\u003eThe audio file an instant agent can play to a lead’s answering machine when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_voicemail_file","full_name":"remove_voicemail_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003evoicemail_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_music_file","full_name":"hold_music_file","description":"\n\u003cp\u003eCustom music played to an instant agent while on hold when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Falls back to the default hold music when blank.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_hold_music_file","full_name":"remove_hold_music_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003ehold_music_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group used to process the caller’s key press response for this rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_sound_playlist","full_name":"use_sound_playlist","description":"\n\u003cp\u003ePlay a random file from a sound playlist instead of a single uploaded \u003ccode\u003eaudio_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sound_playlist_id","full_name":"sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist to play from when \u003ccode\u003euse_sound_playlist\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_music_sound_playlist_id","full_name":"hold_music_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist played to an instant agent while on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"voicemail_sound_playlist_id","full_name":"voicemail_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist an instant agent can play to a lead’s answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"after_action_sound_playlist_enabled","full_name":"after_action_sound_playlist_enabled","description":"\n\u003cp\u003ePlay a sound playlist after this rule’s action completes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"after_action_sound_playlist_id","full_name":"after_action_sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist played after this rule’s action completes, when \u003ccode\u003eafter_action_sound_playlist_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhen false, this rule is disabled and skipped. Used to pause a call flow rule, such as an \u003ccode\u003eoff_hook_press_to_accept\u003c/code\u003e flow, without deleting it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_answer_group_id","full_name":"call_router_answer_group_id","description":"\n\u003cp\u003eThe answer group used to process the caller’s response when \u003ccode\u003erouter_type=ask_a_question\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Call Router Answer Group}[/api/docs/1.0/call_router_answer_groups/index.html]. Refer to: {/api/docs/1.0/call_router_answer_groups}[/api/docs/1.0/call_router_answer_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003ePlay A Message?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eNo Message\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003espeak\u003c/th\u003e\u003ctd\u003eSpeak TTS\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaudio\u003c/th\u003e\u003ctd\u003ePlay Audio\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"router_action","full_name":"router_action","description":"\n\u003cp\u003eChoose An Action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003edial\u003c/th\u003e\u003ctd\u003eForward To Buyers or Agents\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eredirect\u003c/th\u003e\u003ctd\u003eForward To Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_schedule\u003c/th\u003e\u003ctd\u003eAdd To Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_hold_queue\u003c/th\u003e\u003ctd\u003ePlace Caller In Hold Queue\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eremove_from_schedule\u003c/th\u003e\u003ctd\u003eRemove From Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erecord_voicemail\u003c/th\u003e\u003ctd\u003eRecord Voicemail\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erequest_key_press\u003c/th\u003e\u003ctd\u003eRequest Key Press\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eblock_caller\u003c/th\u003e\u003ctd\u003eBlock Caller\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eend_call\u003c/th\u003e\u003ctd\u003eHang Up\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eContinue Offer Routing\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribe the purpose of this call flow rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eText To Speech that will be spoken when \u003ccode\u003emessage_type=speak\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_loop","full_name":"message_loop","description":"\n\u003cp\u003eThe message will be repeated this many times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eThe audio file that will be played when \u003ccode\u003emessage_type=audio\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule that will be used when \u003ccode\u003erouter_action=add_to_schedule\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyers when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyer groups when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n\u003cp\u003eCalls will be forwarded to this offer when \u003ccode\u003erouter_action=redirect\u003c/code\u003e\u003c/p\u003e\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":[],"deprecated":false},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. How many people can be on hold?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Set the hold queue size automatically by taking [Active CC * This Percentage]\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Maximum number of seconds a caller can be on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA short label for this call flow rule shown in the call flow list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_action_type","full_name":"message_action_type","description":"\n\u003cp\u003eThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech_gender","full_name":"text_to_speech_gender","description":"\n\u003cp\u003eThe voice used for the \u003ccode\u003etext_to_speech\u003c/code\u003e message, \u003ccode\u003eMale\u003c/code\u003e or \u003ccode\u003eFemale\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_timeout_seconds","full_name":"key_press_timeout_seconds","description":"\n\u003cp\u003eHow many seconds to wait for a key press before continuing when \u003ccode\u003erouter_type=press_1_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_type","full_name":"traffic_source_action_type","description":"\n\u003cp\u003eHow the traffic source should be altered when this rule runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_id","full_name":"traffic_source_action_id","description":"\n\u003cp\u003eThe traffic source to assign when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e reassigns the traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"traffic_source_action_payout","full_name":"traffic_source_action_payout","description":"\n\u003cp\u003eThe alternate payout applied when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e sets a new payout.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outbound_timeout_seconds","full_name":"outbound_timeout_seconds","description":"\n\u003cp\u003eHow many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_find_a_buyer","full_name":"use_with_find_a_buyer","description":"\n\u003cp\u003eOnly perform this action when a buyer can be matched for the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"perform_action_if_buyer_is_available","full_name":"perform_action_if_buyer_is_available","description":"\n\u003cp\u003eOnly perform this action when a buyer is available. Companion setting to \u003ccode\u003euse_with_find_a_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_retry_next_buyer","full_name":"auto_retry_next_buyer","description":"\n\u003cp\u003eAutomatically dial the next buyer if the current one does not answer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_retry_next_buyer_seconds","full_name":"auto_retry_next_buyer_seconds","description":"\n\u003cp\u003eHow many seconds to wait before dialing the next buyer when \u003ccode\u003eauto_retry_next_buyer\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_call_route_async","full_name":"inbound_call_route_async","description":"\n\u003cp\u003eRoute the inbound call asynchronously instead of holding the caller while this rule runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_no_lead_timeout","full_name":"off_hook_no_lead_timeout","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent can go without a matching lead before instant agent dialing stops.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_calls_per_seat","full_name":"off_hook_calls_per_seat","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many outbound calls to place per available agent seat.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_unaccepted_wait","full_name":"off_hook_unaccepted_wait","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent has to accept an offered call before it is considered unaccepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_leads_needed","full_name":"off_hook_leads_needed","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many matching leads must be available before dialing an agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_dropped_call_seconds","full_name":"off_hook_dropped_call_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The lookback window, in seconds, used to calculate the dropped call percentage.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_1","full_name":"off_hook_drop_limit_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The first dropped call percentage threshold that throttles outbound dialing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_1","full_name":"off_hook_drop_cps_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_1\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_2","full_name":"off_hook_drop_limit_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The second, higher dropped call percentage threshold that throttles outbound dialing further.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_2","full_name":"off_hook_drop_cps_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_2\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_digit","full_name":"action_digit","description":"\n\u003cp\u003eOnly perform this action if the caller pressed this key.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_call_disposition_wait_seconds","full_name":"max_call_disposition_wait_seconds","description":"\n\u003cp\u003eHow many seconds to wait for an agent to disposition a call before moving on.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_hangup_reason","full_name":"call_router_hangup_reason","description":"\n\u003cp\u003eThe reason recorded on the call when this rule hangs up the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fire_call_router_webhooks_before_action","full_name":"fire_call_router_webhooks_before_action","description":"\n\u003cp\u003eFire this rule’s outgoing webhooks before performing its action instead of after.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_ids","full_name":"backup_buyer_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow agents dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow buyer groups dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e/\u003ccode\u003ebuyer_group_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_file","full_name":"voicemail_file","description":"\n\u003cp\u003eThe audio file an instant agent can play to a lead’s answering machine when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_voicemail_file","full_name":"remove_voicemail_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003evoicemail_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_music_file","full_name":"hold_music_file","description":"\n\u003cp\u003eCustom music played to an instant agent while on hold when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Falls back to the default hold music when blank.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_hold_music_file","full_name":"remove_hold_music_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003ehold_music_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group used to process the caller’s key press response for this rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_sound_playlist","full_name":"use_sound_playlist","description":"\n\u003cp\u003ePlay a random file from a sound playlist instead of a single uploaded \u003ccode\u003eaudio_file\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sound_playlist_id","full_name":"sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist to play from when \u003ccode\u003euse_sound_playlist\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_music_sound_playlist_id","full_name":"hold_music_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist played to an instant agent while on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"voicemail_sound_playlist_id","full_name":"voicemail_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist an instant agent can play to a lead’s answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"after_action_sound_playlist_enabled","full_name":"after_action_sound_playlist_enabled","description":"\n\u003cp\u003ePlay a sound playlist after this rule’s action completes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"after_action_sound_playlist_id","full_name":"after_action_sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist played after this rule’s action completes, when \u003ccode\u003eafter_action_sound_playlist_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ecall\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results. A per_page request parameter \u0026gt; 10 is not allowed, cursor must be used instead.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cursor","full_name":"cursor","description":"\n\u003cp\u003eThe API provides a technique called ‘cursoring’ 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 \u003cstrong\u003emetadata.next_cursor\u003c/strong\u003e. 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecording_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncategory\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_called\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnected_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_offer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nquality_assurance_user_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nquality_assurance_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nquality_assurance_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_traffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_buyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nobfuscated_caller_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_city\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_country\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_values\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntotal_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nivr_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempted_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nanswered_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsub_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_repeat_caller\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_revenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_repeat_caller\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_payout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npayout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrackdrive_cost\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_cost\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_sid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhooks_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nended_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisposition_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisposition_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisposition_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisposition_notes\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhangup_cause\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_label","full_name":"created_at_label","description":"\n\u003cp\u003eDynamic Date String such as “Today” or “This Year”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eLast 5 Min\u003c/code\u003e, \u003ccode\u003eLast 15 Min\u003c/code\u003e, \u003ccode\u003eLast 30 Min\u003c/code\u003e, \u003ccode\u003eLast Hour\u003c/code\u003e, \u003ccode\u003eLast 4 Hours\u003c/code\u003e, \u003ccode\u003eLast 6 Hours\u003c/code\u003e, \u003ccode\u003eLast 12 Hours\u003c/code\u003e, \u003ccode\u003eLast Day\u003c/code\u003e, \u003ccode\u003eLast 2 Days\u003c/code\u003e, \u003ccode\u003eToday\u003c/code\u003e, \u003ccode\u003eYesterday\u003c/code\u003e, \u003ccode\u003eThis Week\u003c/code\u003e, \u003ccode\u003eLast Week\u003c/code\u003e, \u003ccode\u003eThis Month\u003c/code\u003e, \u003ccode\u003eLast Month\u003c/code\u003e, \u003ccode\u003eThis Quarter\u003c/code\u003e, \u003ccode\u003eLast Quarter\u003c/code\u003e, \u003ccode\u003eLast 6 Months\u003c/code\u003e, \u003ccode\u003eThis Year\u003c/code\u003e, \u003ccode\u003eLast Year\u003c/code\u003e, \u003ccode\u003eLifetime\u003c/code\u003e, \u003ccode\u003eCustom Range\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_repeat_caller","full_name":"offer_repeat_caller","description":"\n\u003cp\u003eMatch calls where the Traffic Source had a repeat caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_repeat_caller","full_name":"buyer_repeat_caller","description":"\n\u003cp\u003eMatch calls where the Buyer had a repeat caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n\u003cp\u003eDid the buyer convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_converted","full_name":"offer_converted","description":"\n\u003cp\u003eDid the traffic source convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"in_progress","full_name":"in_progress","description":"\n\u003cp\u003eMatch calls that are on-going\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"placed_on_hold","full_name":"placed_on_hold","description":"\n\u003cp\u003eWas the call placed on hold?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_recording","full_name":"has_recording","description":"\n\u003cp\u003eMatch calls that have a recording.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"either_converted","full_name":"either_converted","description":"\n\u003cp\u003eWhether this call’s buyer or traffic source has converted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_duplicated_call","full_name":"buyer_conversion_duplicated_call","description":"\n\u003cp\u003eMatch calls where the callerID was a duplicate against the Buyer’s conversion settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_conversion_duplicated_call","full_name":"offer_conversion_duplicated_call","description":"\n\u003cp\u003eMatch calls where the callerID was a duplicate against the Traffic Source’s conversion settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_buyer","full_name":"no_buyer","description":"\n\u003cp\u003eMatch calls that didn’t connect to a Buyer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_key","full_name":"token_key","description":"\n\u003cp\u003eCalls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value","full_name":"token_value","description":"\n\u003cp\u003eWill 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edirection\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003estart_app_duration\u003c/code\u003e, \u003ccode\u003enumber_id\u003c/code\u003e, \u003ccode\u003eoffer_id\u003c/code\u003e, \u003ccode\u003etraffic_source_id\u003c/code\u003e, \u003ccode\u003esub_id\u003c/code\u003e, \u003ccode\u003ebuyer_id\u003c/code\u003e, \u003ccode\u003ecaller_number\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003etotal_duration\u003c/code\u003e, \u003ccode\u003ehold_duration\u003c/code\u003e, \u003ccode\u003eivr_duration\u003c/code\u003e, \u003ccode\u003ethird_party_cost\u003c/code\u003e, \u003ccode\u003echarge_total\u003c/code\u003e, \u003ccode\u003eanswered_duration\u003c/code\u003e, \u003ccode\u003eagent_duration\u003c/code\u003e, \u003ccode\u003estatus\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003eoffer_converted\u003c/code\u003e, \u003ccode\u003epayout\u003c/code\u003e, \u003ccode\u003eoutgoing_webhooks_count\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003eend_time\u003c/code\u003e, \u003ccode\u003elead_id\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edesc\u003c/code\u003e, \u003ccode\u003easc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eRefer to the number api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eSchedule internal id.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eRefer to the buyer api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eBuyer Group Internal ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eRefer to the Number Pool api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAn Integer number eg: 12345\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eRefer to the provider api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eMatch calls that were placed by this caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eMatch results that have this status.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ended_at_to","full_name":"ended_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:00:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ended_at_from","full_name":"ended_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:00:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ecall\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_number","full_name":"caller_number","description":"\n\u003cp\u003eThe caller number. EG: +17191112222\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ecall\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecording_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncategory\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_called\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnected_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_offer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nquality_assurance_user_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nquality_assurance_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nquality_assurance_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_traffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_buyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nobfuscated_caller_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_city\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_country\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_values\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntotal_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nivr_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempted_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nanswered_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsub_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_repeat_caller\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_revenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_repeat_caller\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_payout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npayout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrackdrive_cost\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_cost\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_sid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhooks_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nended_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisposition_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisposition_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisposition_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisposition_notes\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhangup_cause\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_repeat_caller","full_name":"offer_repeat_caller","description":"\n\u003cp\u003eMatch calls where the Traffic Source had a repeat caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_repeat_caller","full_name":"buyer_repeat_caller","description":"\n\u003cp\u003eMatch calls where the Buyer had a repeat caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n\u003cp\u003eDid the buyer convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_converted","full_name":"offer_converted","description":"\n\u003cp\u003eDid the traffic source convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"in_progress","full_name":"in_progress","description":"\n\u003cp\u003eMatch calls that are on-going\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"placed_on_hold","full_name":"placed_on_hold","description":"\n\u003cp\u003eWas the call placed on hold?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_recording","full_name":"has_recording","description":"\n\u003cp\u003eMatch calls that have a recording.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"either_converted","full_name":"either_converted","description":"\n\u003cp\u003eWhether this call’s buyer or traffic source has converted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_duplicated_call","full_name":"buyer_conversion_duplicated_call","description":"\n\u003cp\u003eMatch calls where the callerID was a duplicate against the Buyer’s conversion settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_conversion_duplicated_call","full_name":"offer_conversion_duplicated_call","description":"\n\u003cp\u003eMatch calls where the callerID was a duplicate against the Traffic Source’s conversion settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_buyer","full_name":"no_buyer","description":"\n\u003cp\u003eMatch calls that didn’t connect to a Buyer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_key","full_name":"token_key","description":"\n\u003cp\u003eCalls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value","full_name":"token_value","description":"\n\u003cp\u003eWill 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edirection\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003estart_app_duration\u003c/code\u003e, \u003ccode\u003enumber_id\u003c/code\u003e, \u003ccode\u003eoffer_id\u003c/code\u003e, \u003ccode\u003etraffic_source_id\u003c/code\u003e, \u003ccode\u003esub_id\u003c/code\u003e, \u003ccode\u003ebuyer_id\u003c/code\u003e, \u003ccode\u003ecaller_number\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003etotal_duration\u003c/code\u003e, \u003ccode\u003ehold_duration\u003c/code\u003e, \u003ccode\u003eivr_duration\u003c/code\u003e, \u003ccode\u003ethird_party_cost\u003c/code\u003e, \u003ccode\u003echarge_total\u003c/code\u003e, \u003ccode\u003eanswered_duration\u003c/code\u003e, \u003ccode\u003eagent_duration\u003c/code\u003e, \u003ccode\u003estatus\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003eoffer_converted\u003c/code\u003e, \u003ccode\u003epayout\u003c/code\u003e, \u003ccode\u003eoutgoing_webhooks_count\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003eend_time\u003c/code\u003e, \u003ccode\u003elead_id\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edesc\u003c/code\u003e, \u003ccode\u003easc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eRefer to the number api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eSchedule internal id.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eRefer to the buyer api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eBuyer Group Internal ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eRefer to the Number Pool api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAn Integer number eg: 12345\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eRefer to the provider api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eMatch calls that were placed by this caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eMatch results that have this status.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ended_at_to","full_name":"ended_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:00:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ended_at_from","full_name":"ended_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:00:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 call statistics by category and interval","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"group_by","full_name":"group_by","description":"\n\u003cp\u003eGroup calls by one of these attributes.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003eoffer_converted\u003c/code\u003e, \u003ccode\u003estatus\u003c/code\u003e, \u003ccode\u003ecreated_at_five_minutes\u003c/code\u003e, \u003ccode\u003ecreated_at_day\u003c/code\u003e, \u003ccode\u003ecreated_at_week\u003c/code\u003e, \u003ccode\u003ecreated_at_month\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stat","full_name":"stat","description":"\n\u003cp\u003eReturn statistics on the grouped calls by one of these numeric columns.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecount\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003eprofit\u003c/code\u003e, \u003ccode\u003ecost\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_repeat_caller","full_name":"offer_repeat_caller","description":"\n\u003cp\u003eMatch calls where the Traffic Source had a repeat caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_repeat_caller","full_name":"buyer_repeat_caller","description":"\n\u003cp\u003eMatch calls where the Buyer had a repeat caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n\u003cp\u003eDid the buyer convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_converted","full_name":"offer_converted","description":"\n\u003cp\u003eDid the traffic source convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"in_progress","full_name":"in_progress","description":"\n\u003cp\u003eMatch calls that are on-going\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"placed_on_hold","full_name":"placed_on_hold","description":"\n\u003cp\u003eWas the call placed on hold?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_recording","full_name":"has_recording","description":"\n\u003cp\u003eMatch calls that have a recording.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"either_converted","full_name":"either_converted","description":"\n\u003cp\u003eWhether this call’s buyer or traffic source has converted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_duplicated_call","full_name":"buyer_conversion_duplicated_call","description":"\n\u003cp\u003eMatch calls where the callerID was a duplicate against the Buyer’s conversion settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_conversion_duplicated_call","full_name":"offer_conversion_duplicated_call","description":"\n\u003cp\u003eMatch calls where the callerID was a duplicate against the Traffic Source’s conversion settings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"no_buyer","full_name":"no_buyer","description":"\n\u003cp\u003eMatch calls that didn’t connect to a Buyer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_key","full_name":"token_key","description":"\n\u003cp\u003eCalls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value","full_name":"token_value","description":"\n\u003cp\u003eWill 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edirection\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003estart_app_duration\u003c/code\u003e, \u003ccode\u003enumber_id\u003c/code\u003e, \u003ccode\u003eoffer_id\u003c/code\u003e, \u003ccode\u003etraffic_source_id\u003c/code\u003e, \u003ccode\u003esub_id\u003c/code\u003e, \u003ccode\u003ebuyer_id\u003c/code\u003e, \u003ccode\u003ecaller_number\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003etotal_duration\u003c/code\u003e, \u003ccode\u003ehold_duration\u003c/code\u003e, \u003ccode\u003eivr_duration\u003c/code\u003e, \u003ccode\u003ethird_party_cost\u003c/code\u003e, \u003ccode\u003echarge_total\u003c/code\u003e, \u003ccode\u003eanswered_duration\u003c/code\u003e, \u003ccode\u003eagent_duration\u003c/code\u003e, \u003ccode\u003estatus\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003erevenue\u003c/code\u003e, \u003ccode\u003eoffer_converted\u003c/code\u003e, \u003ccode\u003epayout\u003c/code\u003e, \u003ccode\u003eoutgoing_webhooks_count\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003eend_time\u003c/code\u003e, \u003ccode\u003elead_id\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edesc\u003c/code\u003e, \u003ccode\u003easc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eRefer to the number api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eSchedule internal id.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eRefer to the buyer api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eBuyer Group Internal ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eRefer to the Number Pool api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAn Integer number eg: 12345\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eRefer to the provider api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eMatch calls that were placed by this caller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eMatch results that have this status.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ended_at_to","full_name":"ended_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:00:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ended_at_from","full_name":"ended_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:00:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ecall\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"from","full_name":"from","description":"\n\u003cp\u003eThe call will originate from this address (+E.164 formatted phone number.) Example: +18665550001\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"to","description":"\n\u003cp\u003eThe call will be placed to this receiving address (+E.164 formatted phone number.) Example: +18665550001\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eOptional. Associate this call with this lead.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eOptional. 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.\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOptional. Associate this call with a matching lead on this offer. If no lead currently exists, one will be created on this offer.\u003c/p\u003e\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":[],"deprecated":false}],"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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ecall\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eFind the call by \u003ccode\u003eCall ID\u003c/code\u003e or \u003ccode\u003eCall UUID\u003c/code\u003e. \u003cbr\u003e\u003cbr\u003eExample ID \u003ccode\u003e123895022\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003eExample UUID \u003ccode\u003ec3b20b12-3b3b-4322-b15d-0f1c5f653479\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"Get a call's event log","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdvanced 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 Per Advanced Call Analysis Rate, shown on your Rate Sheet. The default rate is 0.0002/request.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"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 ID or UUID","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate a call by \u003ccode\u003eCall ID\u003c/code\u003e or \u003ccode\u003eCall UUID\u003c/code\u003e with contact fields, revenue, payout, and more.\u003c/p\u003e\n","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ecall\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eFind the call by \u003ccode\u003eCall ID\u003c/code\u003e or \u003ccode\u003eCall UUID\u003c/code\u003e. \u003cbr\u003e\u003cbr\u003eExample ID \u003ccode\u003e123895022\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003eExample UUID \u003ccode\u003ec3b20b12-3b3b-4322-b15d-0f1c5f653479\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_call_tokens","full_name":"post_call_tokens","description":"\n\u003cp\u003eCustom contact fields defined on the offer.\u003cbr\u003e EG: \u003ccode\u003e{first_name: \u0026quot;John\u0026quot;, last_name: \u0026quot;Smith\u0026quot;, zip_code: \u0026quot;90210\u0026quot;}\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue","full_name":"revenue","description":"\n\u003cp\u003eThe revenue paid out for the call.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_revenue","full_name":"add_revenue","description":"\n\u003cp\u003eAdd this amount to the call’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)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_payout","full_name":"add_payout","description":"\n\u003cp\u003eAdd this amount to the call’s current payout.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n\u003cp\u003eDid the buyer convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trackdrive_buyer_id","full_name":"trackdrive_buyer_id","description":"\n\u003cp\u003eUpdate the winning Buyer that is assigned to this call.\u003c/p\u003e\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":[],"deprecated":false},{"name":"payout","full_name":"payout","description":"\n\u003cp\u003eThe amount paid to the traffic source.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_converted","full_name":"offer_converted","description":"\n\u003cp\u003eDid the traffic source convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trackdrive_traffic_source_id","full_name":"trackdrive_traffic_source_id","description":"\n\u003cp\u003eUpdate the Traffic Source that is assigned to this call.\u003c/p\u003e\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":[],"deprecated":false},{"name":"contact_field_type","full_name":"contact_field_type","description":"\n\u003cp\u003ePass an ID belonging to an \u003ccode\u003eAgent Script \u0026amp; Field Type\u003c/code\u003e to select that \u003ccode\u003eCustom Contact Field Type\u003c/code\u003e for this call.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fire_outgoing_webhook_ids","full_name":"fire_outgoing_webhook_ids","description":"\n\u003cp\u003eManually refire the listed outgoing webhook ids against this call.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manual_transcribe","full_name":"manual_transcribe","description":"\n\u003cp\u003eManually transcribe this call using the default transcription group.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n\u003cp\u003eCall Disposition\u003c/p\u003e\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":[],"deprecated":false},{"name":"agent_call_disposition_notes","full_name":"agent_call_disposition_notes","description":"\n\u003cp\u003eNotes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked","full_name":"blocked","description":"\n\u003cp\u003eBlock or unblock this caller’s number. Blocking prevents outbound calls, SMS, and email to them, and blocks their inbound calls and SMS too.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_view_id","full_name":"contact_field_view_id","description":"\n\u003cp\u003eThe Agent Script this call is showing to the agent, which controls its custom fields and instructions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of the record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hang_up","full_name":"hang_up","description":"\n\u003cp\u003eSet to true to immediately hang up this call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_recording_url","full_name":"original_recording_url","description":"\n\u003cp\u003eThe externally hosted recording URL for this call, before it is copied to Trackdrive’s own storage.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reapply_conversions","full_name":"reapply_conversions","description":"\n\u003cp\u003eSet to true to reapply this call’s buyer and offer conversion logic using its current revenue and payout.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rerun_webhooks","full_name":"rerun_webhooks","description":"\n\u003cp\u003eManually refire the webhooks associated with this call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_now","full_name":"schedule_callback_now","description":"\n\u003cp\u003eSchedule an immediate callback.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_random_one_hour","full_name":"schedule_callback_random_one_hour","description":"\n\u003cp\u003eSchedule a callback sometime in the next hour.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 by caller ID","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate a call’s revenue and buyer_converted using the call’s \u003ccode\u003ecaller_id\u003c/code\u003e and \u003ccode\u003eoffer_token\u003c/code\u003e\u003c/p\u003e\n","errors":[],"params":[{"name":"caller_id","full_name":"caller_id","description":"\n\u003cp\u003eThe caller ID for the call that will be updated.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_token","full_name":"offer_token","description":"\n\u003cp\u003eThe \u003ccode\u003eDynamic Number Insertion\u003c/code\u003e token for the offer.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_timeframe","full_name":"call_timeframe","description":"\n\u003cp\u003ePass this optional parameter to restrict the call update to calls made in the last \u003ccode\u003ecall_timeframe\u003c/code\u003e minutes. For Example: Pass 120 if you’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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue","full_name":"revenue","description":"\n\u003cp\u003eSet the call’s revenue to this amount. For example pass 10.50 to set the revenue to 10.50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_revenue","full_name":"add_revenue","description":"\n\u003cp\u003eAdd this amount to the call’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)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_payout","full_name":"add_payout","description":"\n\u003cp\u003eAdd this amount to the call’s current payout.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n\u003cp\u003eCall Disposition\u003c/p\u003e\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":[],"deprecated":false},{"name":"agent_call_disposition_notes","full_name":"agent_call_disposition_notes","description":"\n\u003cp\u003eNotes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n\u003cp\u003eDid the buyer convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["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\u0026add_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":"Trigger a key press flow","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eFind the call by \u003ccode\u003eCall ID\u003c/code\u003e or \u003ccode\u003eCall UUID\u003c/code\u003e. \u003cbr\u003e\u003cbr\u003eExample ID \u003ccode\u003e123895022\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003eExample UUID \u003ccode\u003ec3b20b12-3b3b-4322-b15d-0f1c5f653479\u003c/code\u003e\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"digits","full_name":"digits","description":"\n\u003cp\u003eDTMF digit\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eUpdate the call with this data. \u003ccode\u003e{interest: \u0026#39;kittens\u0026#39;, source: \u0026#39;google\u0026#39;, first_name: \u0026#39;John\u0026#39;, last_name: \u0026#39;Smith\u0026#39;}\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ecall\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eFind the call by \u003ccode\u003eCall ID\u003c/code\u003e or \u003ccode\u003eCall UUID\u003c/code\u003e. \u003cbr\u003e\u003cbr\u003eExample ID \u003ccode\u003e123895022\u003c/code\u003e.\u003cbr\u003e\u003cbr\u003eExample UUID \u003ccode\u003ec3b20b12-3b3b-4322-b15d-0f1c5f653479\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"Lead \u0026 Call Logs","short_description":"A lead \u0026 call 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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"\n\u003cp\u003eThe ID for the record that owns this record.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_type","full_name":"owner_type","description":"\n\u003cp\u003eThe type of record that owns this record.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results. A per_page request parameter \u0026gt; 10 is not allowed, cursor must be used instead.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cursor","full_name":"cursor","description":"\n\u003cp\u003eThe API provides a technique called ‘cursoring’ 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 \u003cstrong\u003emetadata.next_cursor\u003c/strong\u003e. 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nemail\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_ip\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbatch_action_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nadmin_user_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncollaborator_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nparams\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontroller_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_method\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_body\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_agent\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndiff\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfrom_attrs\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nto_attrs\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npretty_diff\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_params\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":"charge_type","full_name":"charge_type","description":"\n\u003cp\u003eDifferent types of charges including calls, SMS, transcriptions, reporting, and number-related fees.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eSchedule internal id.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncharge_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\namount\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsms_blast_messages_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nthird_party_cost\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsms_ai_charges_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncharges_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_action_logs_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscriptions_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndnc_check_logs_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"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\u003cp\u003eThe type of collection to return.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003ebuyer_group_table_details\u003c/th\u003e\u003ctd\u003eBuyer Group Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_table_details\u003c/th\u003e\u003ctd\u003eBuyer Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_buyer_id\u003c/th\u003e\u003ctd\u003eCall Buyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_category\u003c/th\u003e\u003ctd\u003eCall Category\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_child_buyer_id\u003c/th\u003e\u003ctd\u003eCall Child Buyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_contact_field_type\u003c/th\u003e\u003ctd\u003eCall Contact Field Type\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_country\u003c/th\u003e\u003ctd\u003eCall Country\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_hangup_cause_code\u003c/th\u003e\u003ctd\u003eCall Hangup Cause Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_hangup_cause_status\u003c/th\u003e\u003ctd\u003eCall Hangup Cause Status\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_hung_up_by\u003c/th\u003e\u003ctd\u003eCall Hung Up By\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_offer_id\u003c/th\u003e\u003ctd\u003eCall Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_report_table_details\u003c/th\u003e\u003ctd\u003eCall Report Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_state_province\u003c/th\u003e\u003ctd\u003eCall State Province\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_status\u003c/th\u003e\u003ctd\u003eCall Status\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_sub_id\u003c/th\u003e\u003ctd\u003eCall Sub\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_table_details\u003c/th\u003e\u003ctd\u003eCall Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_token_values_map\u003c/th\u003e\u003ctd\u003eCall Token Values Map\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_zip_postal_code\u003c/th\u003e\u003ctd\u003eZip / Postal Codes On Calls\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecountries\u003c/th\u003e\u003ctd\u003eCountries\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003efacet_categories\u003c/th\u003e\u003ctd\u003eFacet Categories\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_contact_field_type\u003c/th\u003e\u003ctd\u003eLead Contact Field Type\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_country\u003c/th\u003e\u003ctd\u003eLead Country\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_dial_number_id\u003c/th\u003e\u003ctd\u003eLead Dial Number\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_dial_tier\u003c/th\u003e\u003ctd\u003eLead Dial Tier\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_lead_import_id\u003c/th\u003e\u003ctd\u003eLead Lead Import\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_report_table_details\u003c/th\u003e\u003ctd\u003eLead Report Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_schedule_trigger_type\u003c/th\u003e\u003ctd\u003eLead Schedule Trigger Type\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_sms_number_id\u003c/th\u003e\u003ctd\u003eLead Sms Number\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_state_province\u003c/th\u003e\u003ctd\u003eLead State Province\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_status\u003c/th\u003e\u003ctd\u003eLead Status\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_status\u003c/th\u003e\u003ctd\u003eLead Status\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_sub_id\u003c/th\u003e\u003ctd\u003eLead Sub\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_table_details\u003c/th\u003e\u003ctd\u003eLead Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_token_values_map\u003c/th\u003e\u003ctd\u003eLead Token Values Map\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_zip_postal_code\u003c/th\u003e\u003ctd\u003eLead Zip Postal Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enumber_table_details\u003c/th\u003e\u003ctd\u003eNumber Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_table_details\u003c/th\u003e\u003ctd\u003eOffer Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ering_pool_table_details\u003c/th\u003e\u003ctd\u003eRing Pool Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_table_details\u003c/th\u003e\u003ctd\u003eSchedule Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003estates\u003c/th\u003e\u003ctd\u003eStates\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etime_zone\u003c/th\u003e\u003ctd\u003eTime Zone\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etraffic_source_table_details\u003c/th\u003e\u003ctd\u003eTraffic Source Table Details\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewebhook_ips\u003c/th\u003e\u003ctd\u003eWebhook Ips\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_label","full_name":"created_at_label","description":"\n\u003cp\u003eDynamic Date String such as “Today” or “This Year”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eLast 5 Min\u003c/code\u003e, \u003ccode\u003eLast 15 Min\u003c/code\u003e, \u003ccode\u003eLast 30 Min\u003c/code\u003e, \u003ccode\u003eLast Hour\u003c/code\u003e, \u003ccode\u003eLast 4 Hours\u003c/code\u003e, \u003ccode\u003eLast 6 Hours\u003c/code\u003e, \u003ccode\u003eLast 12 Hours\u003c/code\u003e, \u003ccode\u003eLast Day\u003c/code\u003e, \u003ccode\u003eLast 2 Days\u003c/code\u003e, \u003ccode\u003eToday\u003c/code\u003e, \u003ccode\u003eYesterday\u003c/code\u003e, \u003ccode\u003eThis Week\u003c/code\u003e, \u003ccode\u003eLast Week\u003c/code\u003e, \u003ccode\u003eThis Month\u003c/code\u003e, \u003ccode\u003eLast Month\u003c/code\u003e, \u003ccode\u003eThis Quarter\u003c/code\u003e, \u003ccode\u003eLast Quarter\u003c/code\u003e, \u003ccode\u003eLast 6 Months\u003c/code\u003e, \u003ccode\u003eThis Year\u003c/code\u003e, \u003ccode\u003eLast Year\u003c/code\u003e, \u003ccode\u003eLifetime\u003c/code\u003e, \u003ccode\u003eCustom Range\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"My 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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nemail\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsubdomain_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsubdomain\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbalance\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackground_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_color\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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},"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":"Predefined picklist options and display labels for a contact field that uses a dropdown or select input.","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\u003cp\u003eThe Contact Field this picklist value belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the record to this Contact Field.\u003c/p\u003e\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":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eDisplay Name For Value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly offers this picklist value for calls matching these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Contact Field.\u003c/p\u003e\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":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eDisplay Name For Value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly offers this picklist value for calls matching these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Contact Field.\u003c/p\u003e\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":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eDisplay Name For Value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly offers this picklist value for calls matching these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Agent scripts shown during calls, combining contact field inputs with instructions agents read from and fill in live.","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\u003cp\u003eThe offer this Agent Script belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscript_javascript\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\njornaya_campaign_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfields_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntitle\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscript_html\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_keys\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_default\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_when_tokens_match\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n\u003cp\u003eAgent Script Display Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fields_type","full_name":"fields_type","description":"\n\u003cp\u003eA unique value that will be submitted with leads to select this field type and agent script.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"script_html","full_name":"script_html","description":"\n\u003cp\u003eThis 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_keys","full_name":"token_keys","description":"\n\u003cp\u003eThese fields will be visible when this field_type is selected.\u003c/p\u003e\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":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"\n\u003cp\u003eUses this Agent Script by default when a call doesn’t match any other Agent Script’s filters.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"script_javascript","full_name":"script_javascript","description":"\n\u003cp\u003eCustom JavaScript run alongside this Agent Script while agents are on the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jornaya_campaign_id","full_name":"jornaya_campaign_id","description":"\n\u003cp\u003eThe Jornaya campaign id associated with this Agent Script.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_tokens_match","full_name":"use_when_tokens_match","description":"\n\u003cp\u003eOnly uses this Agent Script for calls matching the token filters below.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly uses this Agent Script for calls matching these token values.\u003cbr\u003e Obtain token value ids from the Token Values collection.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eWhen this Agent Script is used on a call, the call will be tagged with these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAgent Script Display Name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"fields_type","full_name":"fields_type","description":"\n\u003cp\u003eA unique value that will be submitted with leads to select this field type and agent script.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"script_html","full_name":"script_html","description":"\n\u003cp\u003eThis 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_keys","full_name":"token_keys","description":"\n\u003cp\u003eThese fields will be visible when this field_type is selected.\u003c/p\u003e\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":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"\n\u003cp\u003eUses this Agent Script by default when a call doesn’t match any other Agent Script’s filters.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"script_javascript","full_name":"script_javascript","description":"\n\u003cp\u003eCustom JavaScript run alongside this Agent Script while agents are on the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jornaya_campaign_id","full_name":"jornaya_campaign_id","description":"\n\u003cp\u003eThe Jornaya campaign id associated with this Agent Script.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_tokens_match","full_name":"use_when_tokens_match","description":"\n\u003cp\u003eOnly uses this Agent Script for calls matching the token filters below.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly uses this Agent Script for calls matching these token values.\u003cbr\u003e Obtain token value ids from the Token Values collection.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eWhen this Agent Script is used on a call, the call will be tagged with these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n\u003cp\u003eAgent Script Display Name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fields_type","full_name":"fields_type","description":"\n\u003cp\u003eA unique value that will be submitted with leads to select this field type and agent script.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"script_html","full_name":"script_html","description":"\n\u003cp\u003eThis 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_keys","full_name":"token_keys","description":"\n\u003cp\u003eThese fields will be visible when this field_type is selected.\u003c/p\u003e\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":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"\n\u003cp\u003eUses this Agent Script by default when a call doesn’t match any other Agent Script’s filters.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"script_javascript","full_name":"script_javascript","description":"\n\u003cp\u003eCustom JavaScript run alongside this Agent Script while agents are on the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jornaya_campaign_id","full_name":"jornaya_campaign_id","description":"\n\u003cp\u003eThe Jornaya campaign id associated with this Agent Script.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_when_tokens_match","full_name":"use_when_tokens_match","description":"\n\u003cp\u003eOnly uses this Agent Script for calls matching the token filters below.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly uses this Agent Script for calls matching these token values.\u003cbr\u003e Obtain token value ids from the Token Values collection.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eWhen this Agent Script is used on a call, the call will be tagged with these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Custom data fields attached to an offer's leads, defining what information is captured and how it's validated.","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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003econtact_field\u003c/th\u003e\u003ctd\u003eContact Field\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact_field_form\u003c/th\u003e\u003ctd\u003eContact Field Form\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequired\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequired_on_create\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequired_on_ping\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncheck_buyer_filters_before_calling\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhint\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue_formatter\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue_expression\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhtml_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_value_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_in_docs\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_in_tables\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_in_reports\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue_decimal_min\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue_decimal_max\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndecimal_places\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninclude_blank\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nboolean_true_text\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nboolean_false_text\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackground_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_values_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncheck_buyer_filters_allow_blank\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue_pattern_validation\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncheck_pattern_validation\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_values_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndate_picker_in_future\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndate_picker_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nshow_on_manual_dialer\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"required","description":"\n\u003cp\u003eIs this field required?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this field.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_type","full_name":"value_type","description":"\n\u003cp\u003eField Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003edecimal\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003etime\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003eexpression\u003c/code\u003e, \u003ccode\u003ehidden\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"decimal_places","full_name":"decimal_places","description":"\n\u003cp\u003eDecimal values/expressions will be rounded to this many decimal places.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_formatter","full_name":"value_formatter","description":"\n\u003cp\u003eExpression Formatter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003edecimal\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003etime\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\n\u003cp\u003eExpression\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required_on_create","full_name":"required_on_create","description":"\n\u003cp\u003eRequires this field to have a value before a Lead can be created.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required_on_ping","full_name":"required_on_ping","description":"\n\u003cp\u003eRequires this field to have a value before this Offer’s buyers can be pinged.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"html_id","full_name":"html_id","description":"\n\u003cp\u003eA custom HTML id for this field’s input, used to target it with your own CSS or JavaScript.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe background color used to display this field’s token, as a hex code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe text color used to display this field’s token, as a hex code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_docs","full_name":"show_in_docs","description":"\n\u003cp\u003eIncludes this field in the integration guide and posting instructions shown to your traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShows this field as a column in tables throughout the app.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShows this field as an option when building reports.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_manual_dialer","full_name":"show_on_manual_dialer","description":"\n\u003cp\u003eShows this field on the manual dialer screen.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_buyer_filters_before_calling","full_name":"check_buyer_filters_before_calling","description":"\n\u003cp\u003eConsiders this field’s value when applying buyer filters before calling.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_buyer_filters_allow_blank","full_name":"check_buyer_filters_allow_blank","description":"\n\u003cp\u003eAllows a blank value to pass buyer filters instead of blocking the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_decimal_min","full_name":"value_decimal_min","description":"\n\u003cp\u003eThe minimum acceptable value, used when the field type is Decimal or Integer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_decimal_max","full_name":"value_decimal_max","description":"\n\u003cp\u003eThe maximum acceptable value, used when the field type is Decimal or Integer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_date_min","full_name":"value_date_min","description":"\n\u003cp\u003eThe earliest acceptable date, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_date_max","full_name":"value_date_max","description":"\n\u003cp\u003eThe latest acceptable date, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_picker_enabled","full_name":"date_picker_enabled","description":"\n\u003cp\u003eShows a date picker for entering this field’s value, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_picker_in_future","full_name":"date_picker_in_future","description":"\n\u003cp\u003eRestricts the date picker to future dates only, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"boolean_true_text","full_name":"boolean_true_text","description":"\n\u003cp\u003eThe label displayed for a true value, used when the field type is Boolean.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"boolean_false_text","full_name":"boolean_false_text","description":"\n\u003cp\u003eThe label displayed for a false value, used when the field type is Boolean.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_blank","full_name":"include_blank","description":"\n\u003cp\u003eIncludes a blank option in the list of acceptable values, used when the field type is Boolean or String.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_values_type","full_name":"contact_field_values_type","description":"\n\u003cp\u003eWhere the list of acceptable values for this field comes from.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecustom\u003c/code\u003e, \u003ccode\u003ecountries\u003c/code\u003e, \u003ccode\u003eusa_states\u003c/code\u003e, \u003ccode\u003ecanada_provinces\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_pattern_validation","full_name":"check_pattern_validation","description":"\n\u003cp\u003eValidates this field’s value against the pattern selected in value_pattern_validation.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_pattern_validation","full_name":"value_pattern_validation","description":"\n\u003cp\u003eThe pattern this field’s value must match, used when check_pattern_validation is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edate_YYYY-MM-DD\u003c/code\u003e, \u003ccode\u003edate_DD/MM/YYYY\u003c/code\u003e, \u003ccode\u003edate_DD-MM-YYYY\u003c/code\u003e, \u003ccode\u003edate_MM/DD/YYYY\u003c/code\u003e, \u003ccode\u003edate_MM-DD-YYYY\u003c/code\u003e, \u003ccode\u003eemail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"required","description":"\n\u003cp\u003eIs this field required?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this field.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_type","full_name":"value_type","description":"\n\u003cp\u003eField Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003edecimal\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003etime\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003eexpression\u003c/code\u003e, \u003ccode\u003ehidden\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"decimal_places","full_name":"decimal_places","description":"\n\u003cp\u003eDecimal values/expressions will be rounded to this many decimal places.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_formatter","full_name":"value_formatter","description":"\n\u003cp\u003eExpression Formatter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003edecimal\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003etime\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\n\u003cp\u003eExpression\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required_on_create","full_name":"required_on_create","description":"\n\u003cp\u003eRequires this field to have a value before a Lead can be created.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required_on_ping","full_name":"required_on_ping","description":"\n\u003cp\u003eRequires this field to have a value before this Offer’s buyers can be pinged.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"html_id","full_name":"html_id","description":"\n\u003cp\u003eA custom HTML id for this field’s input, used to target it with your own CSS or JavaScript.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe background color used to display this field’s token, as a hex code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe text color used to display this field’s token, as a hex code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_docs","full_name":"show_in_docs","description":"\n\u003cp\u003eIncludes this field in the integration guide and posting instructions shown to your traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShows this field as a column in tables throughout the app.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShows this field as an option when building reports.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_manual_dialer","full_name":"show_on_manual_dialer","description":"\n\u003cp\u003eShows this field on the manual dialer screen.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_buyer_filters_before_calling","full_name":"check_buyer_filters_before_calling","description":"\n\u003cp\u003eConsiders this field’s value when applying buyer filters before calling.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_buyer_filters_allow_blank","full_name":"check_buyer_filters_allow_blank","description":"\n\u003cp\u003eAllows a blank value to pass buyer filters instead of blocking the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_decimal_min","full_name":"value_decimal_min","description":"\n\u003cp\u003eThe minimum acceptable value, used when the field type is Decimal or Integer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_decimal_max","full_name":"value_decimal_max","description":"\n\u003cp\u003eThe maximum acceptable value, used when the field type is Decimal or Integer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_date_min","full_name":"value_date_min","description":"\n\u003cp\u003eThe earliest acceptable date, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_date_max","full_name":"value_date_max","description":"\n\u003cp\u003eThe latest acceptable date, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_picker_enabled","full_name":"date_picker_enabled","description":"\n\u003cp\u003eShows a date picker for entering this field’s value, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_picker_in_future","full_name":"date_picker_in_future","description":"\n\u003cp\u003eRestricts the date picker to future dates only, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"boolean_true_text","full_name":"boolean_true_text","description":"\n\u003cp\u003eThe label displayed for a true value, used when the field type is Boolean.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"boolean_false_text","full_name":"boolean_false_text","description":"\n\u003cp\u003eThe label displayed for a false value, used when the field type is Boolean.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_blank","full_name":"include_blank","description":"\n\u003cp\u003eIncludes a blank option in the list of acceptable values, used when the field type is Boolean or String.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_values_type","full_name":"contact_field_values_type","description":"\n\u003cp\u003eWhere the list of acceptable values for this field comes from.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecustom\u003c/code\u003e, \u003ccode\u003ecountries\u003c/code\u003e, \u003ccode\u003eusa_states\u003c/code\u003e, \u003ccode\u003ecanada_provinces\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_pattern_validation","full_name":"check_pattern_validation","description":"\n\u003cp\u003eValidates this field’s value against the pattern selected in value_pattern_validation.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_pattern_validation","full_name":"value_pattern_validation","description":"\n\u003cp\u003eThe pattern this field’s value must match, used when check_pattern_validation is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edate_YYYY-MM-DD\u003c/code\u003e, \u003ccode\u003edate_DD/MM/YYYY\u003c/code\u003e, \u003ccode\u003edate_DD-MM-YYYY\u003c/code\u003e, \u003ccode\u003edate_MM/DD/YYYY\u003c/code\u003e, \u003ccode\u003edate_MM-DD-YYYY\u003c/code\u003e, \u003ccode\u003eemail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required","full_name":"required","description":"\n\u003cp\u003eIs this field required?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe friendly human name displayed to users.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hint","full_name":"hint","description":"\n\u003cp\u003eDisplay a helpful hint to users explaining the purpose of this field.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_type","full_name":"value_type","description":"\n\u003cp\u003eField Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003edecimal\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003etime\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003eexpression\u003c/code\u003e, \u003ccode\u003ehidden\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"decimal_places","full_name":"decimal_places","description":"\n\u003cp\u003eDecimal values/expressions will be rounded to this many decimal places.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_formatter","full_name":"value_formatter","description":"\n\u003cp\u003eExpression Formatter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003edecimal\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003etime\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\n\u003cp\u003eExpression\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required_on_create","full_name":"required_on_create","description":"\n\u003cp\u003eRequires this field to have a value before a Lead can be created.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required_on_ping","full_name":"required_on_ping","description":"\n\u003cp\u003eRequires this field to have a value before this Offer’s buyers can be pinged.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"html_id","full_name":"html_id","description":"\n\u003cp\u003eA custom HTML id for this field’s input, used to target it with your own CSS or JavaScript.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eThe background color used to display this field’s token, as a hex code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eThe text color used to display this field’s token, as a hex code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_docs","full_name":"show_in_docs","description":"\n\u003cp\u003eIncludes this field in the integration guide and posting instructions shown to your traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_tables","full_name":"show_in_tables","description":"\n\u003cp\u003eShows this field as a column in tables throughout the app.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_in_reports","full_name":"show_in_reports","description":"\n\u003cp\u003eShows this field as an option when building reports.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_on_manual_dialer","full_name":"show_on_manual_dialer","description":"\n\u003cp\u003eShows this field on the manual dialer screen.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_buyer_filters_before_calling","full_name":"check_buyer_filters_before_calling","description":"\n\u003cp\u003eConsiders this field’s value when applying buyer filters before calling.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_buyer_filters_allow_blank","full_name":"check_buyer_filters_allow_blank","description":"\n\u003cp\u003eAllows a blank value to pass buyer filters instead of blocking the call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_decimal_min","full_name":"value_decimal_min","description":"\n\u003cp\u003eThe minimum acceptable value, used when the field type is Decimal or Integer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_decimal_max","full_name":"value_decimal_max","description":"\n\u003cp\u003eThe maximum acceptable value, used when the field type is Decimal or Integer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_date_min","full_name":"value_date_min","description":"\n\u003cp\u003eThe earliest acceptable date, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_date_max","full_name":"value_date_max","description":"\n\u003cp\u003eThe latest acceptable date, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_picker_enabled","full_name":"date_picker_enabled","description":"\n\u003cp\u003eShows a date picker for entering this field’s value, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_picker_in_future","full_name":"date_picker_in_future","description":"\n\u003cp\u003eRestricts the date picker to future dates only, used when the field type is Time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"boolean_true_text","full_name":"boolean_true_text","description":"\n\u003cp\u003eThe label displayed for a true value, used when the field type is Boolean.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"boolean_false_text","full_name":"boolean_false_text","description":"\n\u003cp\u003eThe label displayed for a false value, used when the field type is Boolean.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_blank","full_name":"include_blank","description":"\n\u003cp\u003eIncludes a blank option in the list of acceptable values, used when the field type is Boolean or String.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_values_type","full_name":"contact_field_values_type","description":"\n\u003cp\u003eWhere the list of acceptable values for this field comes from.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecustom\u003c/code\u003e, \u003ccode\u003ecountries\u003c/code\u003e, \u003ccode\u003eusa_states\u003c/code\u003e, \u003ccode\u003ecanada_provinces\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_pattern_validation","full_name":"check_pattern_validation","description":"\n\u003cp\u003eValidates this field’s value against the pattern selected in value_pattern_validation.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_pattern_validation","full_name":"value_pattern_validation","description":"\n\u003cp\u003eThe pattern this field’s value must match, used when check_pattern_validation is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003edate_YYYY-MM-DD\u003c/code\u003e, \u003ccode\u003edate_DD/MM/YYYY\u003c/code\u003e, \u003ccode\u003edate_DD-MM-YYYY\u003c/code\u003e, \u003ccode\u003edate_MM/DD/YYYY\u003c/code\u003e, \u003ccode\u003edate_MM-DD-YYYY\u003c/code\u003e, \u003ccode\u003eemail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_maps_set\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_json\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nerror_message\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntotal_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstopped_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfailed_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsucceeded_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nunblock_started_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nunblock_finished_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_block_or_unblock\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nselect_import_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_file_blob\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nheaders\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eThe file containing phone numbers to block or unblock, used when select_import_type is file.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n\u003cp\u003eApply Block Or Unblock\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eblock\u003c/code\u003e, \u003ccode\u003eunblock\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"select_import_type","full_name":"select_import_type","description":"\n\u003cp\u003eUpload Import File Or Text\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003etext_blob\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file_blob","full_name":"import_file_blob","description":"\n\u003cp\u003eText Blob\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_map_caller_id","full_name":"data_map_caller_id","description":"\n\u003cp\u003eThe column header from your uploaded file that contains the phone numbers to block or unblock.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eThe file containing phone numbers to block or unblock, used when select_import_type is file.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n\u003cp\u003eApply Block Or Unblock\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eblock\u003c/code\u003e, \u003ccode\u003eunblock\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"select_import_type","full_name":"select_import_type","description":"\n\u003cp\u003eUpload Import File Or Text\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003etext_blob\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file_blob","full_name":"import_file_blob","description":"\n\u003cp\u003eText Blob\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_map_caller_id","full_name":"data_map_caller_id","description":"\n\u003cp\u003eThe column header from your uploaded file that contains the phone numbers to block or unblock.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of this import.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eThe file containing phone numbers to block or unblock, used when select_import_type is file.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_block_or_unblock","full_name":"apply_block_or_unblock","description":"\n\u003cp\u003eApply Block Or Unblock\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eblock\u003c/code\u003e, \u003ccode\u003eunblock\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"select_import_type","full_name":"select_import_type","description":"\n\u003cp\u003eUpload Import File Or Text\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003etext_blob\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file_blob","full_name":"import_file_blob","description":"\n\u003cp\u003eText Blob\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_map_caller_id","full_name":"data_map_caller_id","description":"\n\u003cp\u003eThe column header from your uploaded file that contains the phone numbers to block or unblock.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"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\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_call_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nblocked\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nopt_out\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncalls_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutbound_call_failure_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutbound_no_answer_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nblocked_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsms_opt_out_at\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/caller_block","name":"caller_block","apis":[{"api_url":"/api/v1/contacts/:caller_id/caller_block","http_method":"POST","short_description":"Blacklist a caller ID","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdd a caller_id to your company blacklist, preventing all inbound and outbound interactions.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLookup a contact by internal id, or by the 10+ digit telephone number. For example:\u003cbr\u003e\u003cbr\u003e To find a number using trackdrive’s internal id pass \u003ccode\u003eid=185923\u003c/code\u003e\u003cbr\u003e\u003cbr\u003e To find a number using the phone number pass \u003ccode\u003eid=18005002562\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked","full_name":"blocked","description":"\n\u003cp\u003eBlock or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls \u0026amp; sms.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/update","name":"update","apis":[{"api_url":"/api/v1/contacts/:id","http_method":"PUT","short_description":"Update a contact","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eLookup a contact by internal id, or by the 10+ digit telephone number. For example:\u003cbr\u003e\u003cbr\u003e To find a number using trackdrive’s internal id pass \u003ccode\u003eid=185923\u003c/code\u003e\u003cbr\u003e\u003cbr\u003e To find a number using the phone number pass \u003ccode\u003eid=18005002562\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opt_out","full_name":"opt_out","description":"\n\u003cp\u003eMark 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked","full_name":"blocked","description":"\n\u003cp\u003eBlock or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls \u0026amp; sms.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/hang_up_calls","name":"hang_up_calls","apis":[{"api_url":"/api/v1/contacts/:id/calls","http_method":"DELETE","short_description":"Hang up a contact's ongoing calls","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eA unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 Groups","short_description":"A named group that organizes related data append configurations used to enrich lead and contact records.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_appends_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Appends","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_append_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nappend_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noverride_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmap_contact_field_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/new","name":"new","apis":[{"api_url":"/api/v1/data_appends/new","http_method":"GET","short_description":"Build a new data append","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_data","full_name":"override_data","description":"\n\u003cp\u003eOverride Existing Data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n\u003cp\u003eMap Contact Field Group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly run this data append for leads matching these token filters. Leads that don’t match are skipped.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThese tokens will be applied to leads processed by this data append.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n\u003cp\u003eData Append Group ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"append_type","full_name":"append_type","description":"\n\u003cp\u003eAppend Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003efree_zip_code\u003c/th\u003e\u003ctd\u003eFree Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_code\u003c/th\u003e\u003ctd\u003eAdvanced Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaddress\u003c/th\u003e\u003ctd\u003eAddress Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact\u003c/th\u003e\u003ctd\u003eContact Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact_plus\u003c/th\u003e\u003ctd\u003eContact+ Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eall\u003c/th\u003e\u003ctd\u003eAll Data\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_data","full_name":"override_data","description":"\n\u003cp\u003eOverride Existing Data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n\u003cp\u003eMap Contact Field Group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly run this data append for leads matching these token filters. Leads that don’t match are skipped.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThese tokens will be applied to leads processed by this data append.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n\u003cp\u003eData Append Group ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"append_type","full_name":"append_type","description":"\n\u003cp\u003eAppend Type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003efree_zip_code\u003c/th\u003e\u003ctd\u003eFree Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_code\u003c/th\u003e\u003ctd\u003eAdvanced Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaddress\u003c/th\u003e\u003ctd\u003eAddress Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact\u003c/th\u003e\u003ctd\u003eContact Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact_plus\u003c/th\u003e\u003ctd\u003eContact+ Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eall\u003c/th\u003e\u003ctd\u003eAll Data\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_data","full_name":"override_data","description":"\n\u003cp\u003eOverride Existing Data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n\u003cp\u003eMap Contact Field Group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly run this data append for leads matching these token filters. Leads that don’t match are skipped.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThese tokens will be applied to leads processed by this data append.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n\u003cp\u003eData Append Group ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"append_type","full_name":"append_type","description":"\n\u003cp\u003eAppend Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003efree_zip_code\u003c/th\u003e\u003ctd\u003eFree Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_code\u003c/th\u003e\u003ctd\u003eAdvanced Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaddress\u003c/th\u003e\u003ctd\u003eAddress Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact\u003c/th\u003e\u003ctd\u003eContact Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact_plus\u003c/th\u003e\u003ctd\u003eContact+ Data\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eall\u003c/th\u003e\u003ctd\u003eAll Data\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Append data for a caller number","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequest data for caller number. This incurs a per API request usage charge on your company based on data type requested.\u003c/p\u003e\n","errors":[],"params":[{"name":"caller_number","full_name":"caller_number","description":"\n\u003cp\u003eThe caller number to retrieve data for.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fetch_type","full_name":"fetch_type","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_zip_code\u003c/code\u003e, \u003ccode\u003ezip_code\u003c/code\u003e, \u003ccode\u003eaddress\u003c/code\u003e, \u003ccode\u003econtact\u003c/code\u003e, \u003ccode\u003econtact_plus\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"\n\u003cp\u003eSpecify the columns you would like returned, e.g. columns=zip_code,city,state\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"data_exports":{"doc_url":"/api/docs/1.0/data_exports","id":"data_exports","api_url":"/api","name":"Data Exports","short_description":"A one-time or recurring export of your account data that runs asynchronously and produces a downloadable file.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/data_exports/index","name":"index","apis":[{"api_url":"/api/v1/data_exports","http_method":"GET","short_description":"List Data Export records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at_from\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsucceeded_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstopped_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntotal_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexport_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexport_file_url\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_exports/show","name":"show","apis":[{"api_url":"/api/v1/data_exports/:data_export_id/download","http_method":"GET","short_description":"Download a data export file.","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRedirects to a time-limited presigned S3 URL for the export file. Returns 404 if the file is not ready.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_exports/create","name":"create","apis":[{"api_url":"/api/v1/data_exports","http_method":"POST","short_description":"Create a one-time data export","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreate a one-time data export. The export runs asynchronously. Poll GET /v1/data_exports/:id for status updates, then download the file via GET /v1/data_exports/:id/download once complete.\u003c/p\u003e\n","errors":[],"params":[{"name":"data_type","full_name":"data_type","description":"\n\u003cp\u003eThe type of data being exported.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the export.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eStart of the date range filter for exported records.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eEnd of the date range filter for exported records.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_label","full_name":"created_at_label","description":"\n\u003cp\u003eA named time range (e.g. today, last-week, this-month). When provided and created_at_from/created_at_to are blank, the label is parsed into a date range.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n\u003cp\u003eArray of column names to include in the export. Defaults to all available columns for the data type if omitted.\u003c/p\u003e\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":[],"deprecated":false},{"name":"serializer_type","full_name":"serializer_type","description":"\n\u003cp\u003eSerializer format for the export (e.g. call_grid for calls).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges in the export filters will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_emails","full_name":"notify_emails","description":"\n\u003cp\u003eEmail addresses to notify when this export finishes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"anonymous_caller","full_name":"anonymous_caller","description":"\n\u003cp\u003eMatch calls where the caller ID was withheld or anonymous.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_attempted","full_name":"buyer_attempted","description":"\n\u003cp\u003eMatch calls where a Buyer was attempted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_connected","full_name":"buyer_connected","description":"\n\u003cp\u003eMatch calls where a Buyer connected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_duplicated_call","full_name":"buyer_conversion_duplicated_call","description":"\n\u003cp\u003eMatch calls where the callerID was a duplicate against the Buyer’s conversion settings.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_repeat_caller","full_name":"buyer_repeat_caller","description":"\n\u003cp\u003eMatch calls where the Buyer had a repeat caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"disconnected","full_name":"disconnected","description":"\n\u003cp\u003eMatch calls that have disconnected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"finished","full_name":"finished","description":"\n\u003cp\u003eMatch leads that have no pending next action, when data_type is lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_barge","full_name":"has_barge","description":"\n\u003cp\u003eMatch calls where a barge occurred (a buyer or agent joined an in-progress call).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_buyer","full_name":"has_buyer","description":"\n\u003cp\u003eMatch calls that connected to a Buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_call","full_name":"has_call","description":"\n\u003cp\u003eMatch leads that have at least one call, when data_type is lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_downstream_call","full_name":"has_downstream_call","description":"\n\u003cp\u003eMatch calls that generated a downstream call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_email","full_name":"has_email","description":"\n\u003cp\u003eMatch records that have an email address.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_next_action","full_name":"has_next_action","description":"\n\u003cp\u003eMatch leads that have a pending next action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_recording","full_name":"has_recording","description":"\n\u003cp\u003eMatch calls that have a recording.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_scheduled_callback","full_name":"has_scheduled_callback","description":"\n\u003cp\u003eMatch calls that have a scheduled callback.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_traffic_source","full_name":"has_traffic_source","description":"\n\u003cp\u003eMatch calls that have a Traffic Source assigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_voicemail","full_name":"has_voicemail","description":"\n\u003cp\u003eMatch calls that left a voicemail.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"in_progress","full_name":"in_progress","description":"\n\u003cp\u003eMatch calls that are on-going\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"internal_call","full_name":"internal_call","description":"\n\u003cp\u003eMatch calls that were placed internally rather than by an external caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_scheduled_callback","full_name":"is_scheduled_callback","description":"\n\u003cp\u003eMatch calls that are themselves a scheduled callback.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"left_voicemail","full_name":"left_voicemail","description":"\n\u003cp\u003eMatch calls that left a voicemail.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manual_opt_in","full_name":"manual_opt_in","description":"\n\u003cp\u003eMatch leads that were manually opted in.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manual_opt_out","full_name":"manual_opt_out","description":"\n\u003cp\u003eMatch leads that were manually opted out.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_action_ready","full_name":"next_action_ready","description":"\n\u003cp\u003eMatch leads whose next action is ready to be processed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_conversion_duplicated_call","full_name":"offer_conversion_duplicated_call","description":"\n\u003cp\u003eMatch calls where the callerID was a duplicate against the Traffic Source’s conversion settings.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_repeat_caller","full_name":"offer_repeat_caller","description":"\n\u003cp\u003eMatch calls where the Traffic Source had a repeat caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opt_out","full_name":"opt_out","description":"\n\u003cp\u003eMatch leads that are opted out.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outbound_call_from_agent","full_name":"outbound_call_from_agent","description":"\n\u003cp\u003eMatch calls placed outbound by an agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"placed_on_hold","full_name":"placed_on_hold","description":"\n\u003cp\u003eWas the call placed on hold?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_sms_enabled","full_name":"provider_sms_enabled","description":"\n\u003cp\u003eMatch records where the provider has SMS enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_present","full_name":"ring_pool_present","description":"\n\u003cp\u003eMatch calls that used a Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transferred","full_name":"transferred","description":"\n\u003cp\u003eMatch calls that were transferred.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"upstream_number_missing","full_name":"upstream_number_missing","description":"\n\u003cp\u003eMatch calls where the upstream Number could not be determined.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_converted_count","full_name":"buyer_converted_count","description":"\n\u003cp\u003eMatch calls with this many Buyer conversions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_tier","full_name":"dial_tier","description":"\n\u003cp\u003eMatch leads with this dial tier (priority) value.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_find_a_buyer_attempts_count","full_name":"off_hook_find_a_buyer_attempts_count","description":"\n\u003cp\u003eMatch calls with this many off-hook find-a-buyer attempts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_converted_count","full_name":"offer_converted_count","description":"\n\u003cp\u003eMatch calls with this many Traffic Source conversions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_status","full_name":"response_status","description":"\n\u003cp\u003eMatch records with this HTTP response status code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_attempt_id","full_name":"buyer_attempt_id","description":"\n\u003cp\u003eMatch calls where this Buyer was attempted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eMatch calls where the Buyer belongs to one of these Buyer Groups.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eMatch calls where this Buyer was the winning Buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n\u003cp\u003eMatch calls suppressed by this Buyer Suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_center_id","full_name":"call_center_id","description":"\n\u003cp\u003eMatch calls handled by this Call Center.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"inbound_webhook_id","full_name":"inbound_webhook_id","description":"\n\u003cp\u003eMatch records generated by this Inbound Webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Incoming Webhook}[/api/docs/1.0/inbound_webhooks/index.html]. Refer to: {/api/docs/1.0/inbound_webhooks}[/api/docs/1.0/inbound_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_import_id","full_name":"lead_import_id","description":"\n\u003cp\u003eMatch leads imported from this Lead Import.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eMatch calls placed to this Number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"off_hook_buyer_id","full_name":"off_hook_buyer_id","description":"\n\u003cp\u003eMatch calls off-hook to this Buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eMatch records belonging to this Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eMatch calls routed through this Provider Configuration.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"qa_buyer_id","full_name":"qa_buyer_id","description":"\n\u003cp\u003eMatch calls where this Buyer was used for quality assurance monitoring.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"recent_call_disposition_id","full_name":"recent_call_disposition_id","description":"\n\u003cp\u003eMatch leads whose most recent call has this Call Disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"referring_call_id","full_name":"referring_call_id","description":"\n\u003cp\u003eMatch calls referred from this Call id.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"referring_number_id","full_name":"referring_number_id","description":"\n\u003cp\u003eMatch calls referred from this Number id.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"referring_offer_id","full_name":"referring_offer_id","description":"\n\u003cp\u003eMatch calls referred from this Offer id.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"referring_schedule_id","full_name":"referring_schedule_id","description":"\n\u003cp\u003eMatch calls referred from this Schedule id.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eMatch calls placed through this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eMatch records belonging to this Schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sms_blast_id","full_name":"sms_blast_id","description":"\n\u003cp\u003eMatch records from this SMS Blast.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Bulk SMS}[/api/docs/1.0/sms_blasts/index.html]. Refer to: {/api/docs/1.0/sms_blasts}[/api/docs/1.0/sms_blasts/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_id","full_name":"token_id","description":"\n\u003cp\u003eMatch records tagged with this Token.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"token_value_id","full_name":"token_value_id","description":"\n\u003cp\u003eMatch records tagged with this Token Value.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"category","full_name":"category","description":"\n\u003cp\u003eGroup results by this field, when data_type is call (e.g. buyer_id, offer_id, status).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n\u003cp\u003eMatch records with this code.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_type","full_name":"contact_field_type","description":"\n\u003cp\u003eMatch records tagged with this Custom Contact Field Type.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"country","description":"\n\u003cp\u003eMatch records from this country.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"creation_source","full_name":"creation_source","description":"\n\u003cp\u003eMatch records created through this source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"direction","description":"\n\u003cp\u003eMatch calls with this direction (e.g. inbound or outbound).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hangup_cause_status","full_name":"hangup_cause_status","description":"\n\u003cp\u003eMatch calls with this hangup cause status.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hangup_source","full_name":"hangup_source","description":"\n\u003cp\u003eMatch calls hung up by this source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hung_up_by","full_name":"hung_up_by","description":"\n\u003cp\u003eMatch calls hung up by this party.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_type","full_name":"off_hook_type","description":"\n\u003cp\u003eMatch calls with this off-hook type.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_type","full_name":"owner_type","description":"\n\u003cp\u003eMatch leads owned by this type of record (Offer or Schedule).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_ip","full_name":"request_ip","description":"\n\u003cp\u003eMatch records submitted from this IP address.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_method","full_name":"request_method","description":"\n\u003cp\u003eMatch records submitted with this HTTP method.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ended_at_label","full_name":"schedule_ended_at_label","description":"\n\u003cp\u003eOnly include leads whose schedule ended within this named timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_trigger_type","full_name":"schedule_trigger_type","description":"\n\u003cp\u003eMatch leads whose end of schedule trigger matches this type.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state","full_name":"state","description":"\n\u003cp\u003eMatch records with this status value.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_province","full_name":"state_province","description":"\n\u003cp\u003eMatch records from this state or province.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sub_id","full_name":"sub_id","description":"\n\u003cp\u003eMatch records with this sub id.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_key","full_name":"token_key","description":"\n\u003cp\u003eCalls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value","full_name":"token_value","description":"\n\u003cp\u003eWill 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_call_at_from","full_name":"last_call_at_from","description":"\n\u003cp\u003eOnly include leads whose most recent call was on or after this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_call_at_to","full_name":"last_call_at_to","description":"\n\u003cp\u003eOnly include leads whose most recent call was on or before this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"optimizer_displayed_at_from","full_name":"optimizer_displayed_at_from","description":"\n\u003cp\u003eOnly include leads whose optimizer results were displayed on or after this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"optimizer_tokens_changed_at_from","full_name":"optimizer_tokens_changed_at_from","description":"\n\u003cp\u003eOnly include leads whose optimizer tokens changed on or after this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ended_at_from","full_name":"schedule_ended_at_from","description":"\n\u003cp\u003eOnly include leads whose schedule ended on or after this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ended_at_to","full_name":"schedule_ended_at_to","description":"\n\u003cp\u003eOnly include leads whose schedule ended on or before this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Real Time 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\u003cp\u003eThe API provides a technique called ‘cursoring’ 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 \u003cstrong\u003emetadata.next_cursor\u003c/strong\u003e. 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"Ping/Post Logs","short_description":"Records of every ping/post request an offer's inbound webhook received, for troubleshooting lead delivery.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninbound_webhook_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_params\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_int\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_method\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsource_ip\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_success\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_logs_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_log_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_uuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_body\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbid_amount\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npayout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessages\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"inbound_webhooks":{"doc_url":"/api/docs/1.0/inbound_webhooks","id":"inbound_webhooks","api_url":"/api","name":"Ping/Post","short_description":"Endpoints that let traffic sources ping for an available buyer and post calls or leads for delivery.","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 for available agents or buyers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\n\u003cp\u003eThe unique identifier for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_token","full_name":"auth_token","description":"\n\u003cp\u003eAuthorize requests using your token. Get it from your profile: \u003ca href=\"https://trackdrive.com/profile/edit\"\u003etrackdrive.com/profile/edit\u003c/a\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 a ping for a tracking number","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003ePOST with a ping_id to retrieve a tracking number for forwarding an inbound call to a matching buyer.\u003c/p\u003e\n","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\n\u003cp\u003eThe unique identifier for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ping_id","full_name":"ping_id","description":"\n\u003cp\u003ePing ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequire_caller_id_on_ping\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvanity_uri\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_body\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequire_traffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequire_user_auth_token\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_subdomain\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntracking_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninclude_dynamic_buyers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ping_column_names\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_post_column_names\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenable_public_show\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenable_public_index\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npublic_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npublic_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npublic_instructions_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntest_mode\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyers_limit_value\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_read_timeout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconcurrency_cap_buffer_percent\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_minute\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_hour\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_day\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_minute_per_traffic_source\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_hour_per_traffic_source\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_day_per_traffic_source\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_append_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_append_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_rate_limiter_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eThe unique identifier for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_type","full_name":"webhook_type","description":"\n\u003cp\u003eWebhook Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003echeck_for_available_instant_agent\u003c/code\u003e, \u003ccode\u003echeck_for_available_buyer\u003c/code\u003e, \u003ccode\u003efire_webhooks\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_ids","full_name":"call_router_ids","description":"\n\u003cp\u003eCall Router Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eBuyer Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eBuyer Group Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_body","full_name":"response_body","description":"\n\u003cp\u003eResponse Body\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eRequire a traffic_source_id on every ping and post to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_caller_id_on_ping","full_name":"require_caller_id_on_ping","description":"\n\u003cp\u003eRequire a caller_id on every ping to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_user_auth_token","full_name":"require_user_auth_token","description":"\n\u003cp\u003eRequire a valid developer access token on every ping and post to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tracking_type","full_name":"tracking_type","description":"\n\u003cp\u003eHow a forwarding number is provided when a buyer is available, such as a number from a Number Pool or the caller’s own number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eThe Number Pool a tracking number is assigned from when tracking_type uses a Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"test_mode","full_name":"test_mode","description":"\n\u003cp\u003eWhen enabled, calls and leads sent to this endpoint are processed without being delivered to buyers, so it can be tested safely.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_dynamic_buyers","full_name":"include_dynamic_buyers","description":"\n\u003cp\u003eAlso search buyers that were dynamically assigned to the offer, not only the buyers and buyer groups selected here.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyers_limit_value","full_name":"buyers_limit_value","description":"\n\u003cp\u003eThe maximum number of available buyers to return on a ping.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n\u003cp\u003eHow many seconds to wait for a response before timing out the request.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"concurrency_cap_buffer_percent","full_name":"concurrency_cap_buffer_percent","description":"\n\u003cp\u003ePercentage buffer applied to buyer concurrency caps when checking for available buyers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_enabled","full_name":"data_append_enabled","description":"\n\u003cp\u003eAppend additional data to leads created through this endpoint using a Data Append Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n\u003cp\u003eThe Data Append Group used to append additional data to leads created through this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Data Append Group}[/api/docs/1.0/data_append_groups/index.html]. Refer to: {/api/docs/1.0/data_append_groups}[/api/docs/1.0/data_append_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_minute","full_name":"rate_limit_per_minute","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per minute, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_hour","full_name":"rate_limit_per_hour","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per hour, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_day","full_name":"rate_limit_per_day","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per day, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_minute_per_traffic_source","full_name":"rate_limit_per_minute_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per minute, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_hour_per_traffic_source","full_name":"rate_limit_per_hour_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per hour, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_day_per_traffic_source","full_name":"rate_limit_per_day_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per day, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_rate_limiter_id","full_name":"traffic_source_rate_limiter_id","description":"\n\u003cp\u003eA Traffic Source Rate Limiter used to apply shared rate limits across multiple traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"buyer_ping_column_names","full_name":"buyer_ping_column_names","description":"\n\u003cp\u003eThe response fields to include for each buyer when responding to a ping.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_post_column_names","full_name":"buyer_post_column_names","description":"\n\u003cp\u003eThe response fields to include when responding to a post.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003eMake this endpoint’s posting instructions viewable on a public, unauthenticated page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eList this endpoint on the public index page of your account’s published posting instructions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe name shown for this endpoint on its public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe description shown for this endpoint on its public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eThe unique identifier for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_type","full_name":"webhook_type","description":"\n\u003cp\u003eWebhook Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003echeck_for_available_instant_agent\u003c/code\u003e, \u003ccode\u003echeck_for_available_buyer\u003c/code\u003e, \u003ccode\u003efire_webhooks\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_ids","full_name":"call_router_ids","description":"\n\u003cp\u003eCall Router Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eBuyer Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eBuyer Group Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_body","full_name":"response_body","description":"\n\u003cp\u003eResponse Body\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eRequire a traffic_source_id on every ping and post to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_caller_id_on_ping","full_name":"require_caller_id_on_ping","description":"\n\u003cp\u003eRequire a caller_id on every ping to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_user_auth_token","full_name":"require_user_auth_token","description":"\n\u003cp\u003eRequire a valid developer access token on every ping and post to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tracking_type","full_name":"tracking_type","description":"\n\u003cp\u003eHow a forwarding number is provided when a buyer is available, such as a number from a Number Pool or the caller’s own number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eThe Number Pool a tracking number is assigned from when tracking_type uses a Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"test_mode","full_name":"test_mode","description":"\n\u003cp\u003eWhen enabled, calls and leads sent to this endpoint are processed without being delivered to buyers, so it can be tested safely.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_dynamic_buyers","full_name":"include_dynamic_buyers","description":"\n\u003cp\u003eAlso search buyers that were dynamically assigned to the offer, not only the buyers and buyer groups selected here.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyers_limit_value","full_name":"buyers_limit_value","description":"\n\u003cp\u003eThe maximum number of available buyers to return on a ping.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n\u003cp\u003eHow many seconds to wait for a response before timing out the request.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"concurrency_cap_buffer_percent","full_name":"concurrency_cap_buffer_percent","description":"\n\u003cp\u003ePercentage buffer applied to buyer concurrency caps when checking for available buyers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_enabled","full_name":"data_append_enabled","description":"\n\u003cp\u003eAppend additional data to leads created through this endpoint using a Data Append Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n\u003cp\u003eThe Data Append Group used to append additional data to leads created through this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Data Append Group}[/api/docs/1.0/data_append_groups/index.html]. Refer to: {/api/docs/1.0/data_append_groups}[/api/docs/1.0/data_append_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_minute","full_name":"rate_limit_per_minute","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per minute, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_hour","full_name":"rate_limit_per_hour","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per hour, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_day","full_name":"rate_limit_per_day","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per day, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_minute_per_traffic_source","full_name":"rate_limit_per_minute_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per minute, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_hour_per_traffic_source","full_name":"rate_limit_per_hour_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per hour, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_day_per_traffic_source","full_name":"rate_limit_per_day_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per day, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_rate_limiter_id","full_name":"traffic_source_rate_limiter_id","description":"\n\u003cp\u003eA Traffic Source Rate Limiter used to apply shared rate limits across multiple traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"buyer_ping_column_names","full_name":"buyer_ping_column_names","description":"\n\u003cp\u003eThe response fields to include for each buyer when responding to a ping.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_post_column_names","full_name":"buyer_post_column_names","description":"\n\u003cp\u003eThe response fields to include when responding to a post.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003eMake this endpoint’s posting instructions viewable on a public, unauthenticated page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eList this endpoint on the public index page of your account’s published posting instructions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe name shown for this endpoint on its public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe description shown for this endpoint on its public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eThe unique identifier for this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_type","full_name":"webhook_type","description":"\n\u003cp\u003eWebhook Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003echeck_for_available_instant_agent\u003c/code\u003e, \u003ccode\u003echeck_for_available_buyer\u003c/code\u003e, \u003ccode\u003efire_webhooks\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_ids","full_name":"call_router_ids","description":"\n\u003cp\u003eCall Router Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eBuyer Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eBuyer Group Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_body","full_name":"response_body","description":"\n\u003cp\u003eResponse Body\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eRequire a traffic_source_id on every ping and post to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_caller_id_on_ping","full_name":"require_caller_id_on_ping","description":"\n\u003cp\u003eRequire a caller_id on every ping to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_user_auth_token","full_name":"require_user_auth_token","description":"\n\u003cp\u003eRequire a valid developer access token on every ping and post to this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tracking_type","full_name":"tracking_type","description":"\n\u003cp\u003eHow a forwarding number is provided when a buyer is available, such as a number from a Number Pool or the caller’s own number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eThe Number Pool a tracking number is assigned from when tracking_type uses a Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"test_mode","full_name":"test_mode","description":"\n\u003cp\u003eWhen enabled, calls and leads sent to this endpoint are processed without being delivered to buyers, so it can be tested safely.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_dynamic_buyers","full_name":"include_dynamic_buyers","description":"\n\u003cp\u003eAlso search buyers that were dynamically assigned to the offer, not only the buyers and buyer groups selected here.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyers_limit_value","full_name":"buyers_limit_value","description":"\n\u003cp\u003eThe maximum number of available buyers to return on a ping.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n\u003cp\u003eHow many seconds to wait for a response before timing out the request.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"concurrency_cap_buffer_percent","full_name":"concurrency_cap_buffer_percent","description":"\n\u003cp\u003ePercentage buffer applied to buyer concurrency caps when checking for available buyers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_enabled","full_name":"data_append_enabled","description":"\n\u003cp\u003eAppend additional data to leads created through this endpoint using a Data Append Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n\u003cp\u003eThe Data Append Group used to append additional data to leads created through this endpoint.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Data Append Group}[/api/docs/1.0/data_append_groups/index.html]. Refer to: {/api/docs/1.0/data_append_groups}[/api/docs/1.0/data_append_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_minute","full_name":"rate_limit_per_minute","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per minute, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_hour","full_name":"rate_limit_per_hour","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per hour, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_day","full_name":"rate_limit_per_day","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per day, across all traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_minute_per_traffic_source","full_name":"rate_limit_per_minute_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per minute, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_hour_per_traffic_source","full_name":"rate_limit_per_hour_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per hour, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_day_per_traffic_source","full_name":"rate_limit_per_day_per_traffic_source","description":"\n\u003cp\u003eMaximum number of requests this endpoint will accept per day, per traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_rate_limiter_id","full_name":"traffic_source_rate_limiter_id","description":"\n\u003cp\u003eA Traffic Source Rate Limiter used to apply shared rate limits across multiple traffic sources.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"buyer_ping_column_names","full_name":"buyer_ping_column_names","description":"\n\u003cp\u003eThe response fields to include for each buyer when responding to a ping.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_post_column_names","full_name":"buyer_post_column_names","description":"\n\u003cp\u003eThe response fields to include when responding to a post.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003eMake this endpoint’s posting instructions viewable on a public, unauthenticated page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eList this endpoint on the public index page of your account’s published posting instructions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe name shown for this endpoint on its public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe description shown for this endpoint on its public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Incoming SMS","short_description":"Inbound SMS messages received on your tracking numbers, linked to the lead, schedule, and number that received them.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfrom\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nto\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nopted_out\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_configuration_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":"A connection to a third-party service or tool that your account uses to send or receive data.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nintegration_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npublic_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncategory\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncategory_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnected_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnected_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndisconnected_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_oauth2\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncache_expires_in\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequests_24h\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsupports_sync\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":null,"full_description":"","errors":[],"params":[{"name":"active","full_name":"active","description":"\n\u003cp\u003eEnable or disable an integration object.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eIntegration Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eblacklist_alliance\u003c/code\u003e, \u003ccode\u003eeleven_labs\u003c/code\u003e, \u003ccode\u003efacebook_capi\u003c/code\u003e, \u003ccode\u003efacebook_leadads\u003c/code\u003e, \u003ccode\u003egoogle_adwords\u003c/code\u003e, \u003ccode\u003einfusionsoft\u003c/code\u003e, \u003ccode\u003emailchimp\u003c/code\u003e, \u003ccode\u003emailgun\u003c/code\u003e, \u003ccode\u003epagerduty\u003c/code\u003e, \u003ccode\u003esalesforce\u003c/code\u003e, \u003ccode\u003esendgrid\u003c/code\u003e, \u003ccode\u003eslack\u003c/code\u003e, \u003ccode\u003esnapchat_capi\u003c/code\u003e, \u003ccode\u003etcpa_shield\u003c/code\u003e, \u003ccode\u003etypeform\u003c/code\u003e, \u003ccode\u003ezadarma\u003c/code\u003e, \u003ccode\u003ezoho_crm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA friendly name for this integration, shown when managing your integrations.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA note describing what this integration is used for.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_key","full_name":"public_key","description":"\n\u003cp\u003eThe public API key issued by the connected service, used to authenticate requests to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"secret_key","full_name":"secret_key","description":"\n\u003cp\u003eThe secret API key issued by the connected service, used to authenticate requests to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pagerduty_integration_key","full_name":"pagerduty_integration_key","description":"\n\u003cp\u003eThe integration key (routing key) from your PagerDuty service, used to send it alerts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"slack_webhook_url","full_name":"slack_webhook_url","description":"\n\u003cp\u003eThe incoming webhook URL from your Slack workspace, used to post messages to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_expires_in","full_name":"cache_expires_in","description":"\n\u003cp\u003eThe number of seconds a lookup result from this integration is cached before it is requested again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"always_trigger","full_name":"always_trigger","description":"\n\u003cp\u003eWhen true, this integration fires for every matching event instead of only events matching its trigger fields.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eIntegration Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eblacklist_alliance\u003c/code\u003e, \u003ccode\u003eeleven_labs\u003c/code\u003e, \u003ccode\u003efacebook_capi\u003c/code\u003e, \u003ccode\u003efacebook_leadads\u003c/code\u003e, \u003ccode\u003egoogle_adwords\u003c/code\u003e, \u003ccode\u003einfusionsoft\u003c/code\u003e, \u003ccode\u003emailchimp\u003c/code\u003e, \u003ccode\u003emailgun\u003c/code\u003e, \u003ccode\u003epagerduty\u003c/code\u003e, \u003ccode\u003esalesforce\u003c/code\u003e, \u003ccode\u003esendgrid\u003c/code\u003e, \u003ccode\u003eslack\u003c/code\u003e, \u003ccode\u003esnapchat_capi\u003c/code\u003e, \u003ccode\u003etcpa_shield\u003c/code\u003e, \u003ccode\u003etypeform\u003c/code\u003e, \u003ccode\u003ezadarma\u003c/code\u003e, \u003ccode\u003ezoho_crm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA friendly name for this integration, shown when managing your integrations.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA note describing what this integration is used for.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_key","full_name":"public_key","description":"\n\u003cp\u003eThe public API key issued by the connected service, used to authenticate requests to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"secret_key","full_name":"secret_key","description":"\n\u003cp\u003eThe secret API key issued by the connected service, used to authenticate requests to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pagerduty_integration_key","full_name":"pagerduty_integration_key","description":"\n\u003cp\u003eThe integration key (routing key) from your PagerDuty service, used to send it alerts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"slack_webhook_url","full_name":"slack_webhook_url","description":"\n\u003cp\u003eThe incoming webhook URL from your Slack workspace, used to post messages to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_expires_in","full_name":"cache_expires_in","description":"\n\u003cp\u003eThe number of seconds a lookup result from this integration is cached before it is requested again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"always_trigger","full_name":"always_trigger","description":"\n\u003cp\u003eWhen true, this integration fires for every matching event instead of only events matching its trigger fields.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eIntegration Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eblacklist_alliance\u003c/code\u003e, \u003ccode\u003eeleven_labs\u003c/code\u003e, \u003ccode\u003efacebook_capi\u003c/code\u003e, \u003ccode\u003efacebook_leadads\u003c/code\u003e, \u003ccode\u003egoogle_adwords\u003c/code\u003e, \u003ccode\u003einfusionsoft\u003c/code\u003e, \u003ccode\u003emailchimp\u003c/code\u003e, \u003ccode\u003emailgun\u003c/code\u003e, \u003ccode\u003epagerduty\u003c/code\u003e, \u003ccode\u003esalesforce\u003c/code\u003e, \u003ccode\u003esendgrid\u003c/code\u003e, \u003ccode\u003eslack\u003c/code\u003e, \u003ccode\u003esnapchat_capi\u003c/code\u003e, \u003ccode\u003etcpa_shield\u003c/code\u003e, \u003ccode\u003etypeform\u003c/code\u003e, \u003ccode\u003ezadarma\u003c/code\u003e, \u003ccode\u003ezoho_crm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA friendly name for this integration, shown when managing your integrations.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA note describing what this integration is used for.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_key","full_name":"public_key","description":"\n\u003cp\u003eThe public API key issued by the connected service, used to authenticate requests to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"secret_key","full_name":"secret_key","description":"\n\u003cp\u003eThe secret API key issued by the connected service, used to authenticate requests to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pagerduty_integration_key","full_name":"pagerduty_integration_key","description":"\n\u003cp\u003eThe integration key (routing key) from your PagerDuty service, used to send it alerts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"slack_webhook_url","full_name":"slack_webhook_url","description":"\n\u003cp\u003eThe incoming webhook URL from your Slack workspace, used to post messages to it.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_expires_in","full_name":"cache_expires_in","description":"\n\u003cp\u003eThe number of seconds a lookup result from this integration is cached before it is requested again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"always_trigger","full_name":"always_trigger","description":"\n\u003cp\u003eWhen true, this integration fires for every matching event instead of only events matching its trigger fields.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Key Press Flow Groups","short_description":"Groups the individual key press actions a caller can use during a call into one reusable set.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nredirect_no_key_press\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"redirect_no_key_press","full_name":"redirect_no_key_press","description":"\n\u003cp\u003eIf the caller doesn’t press a key, use the flow configured for no key press instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"redirect_no_key_press","full_name":"redirect_no_key_press","description":"\n\u003cp\u003eIf the caller doesn’t press a key, use the flow configured for no key press instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"redirect_no_key_press","full_name":"redirect_no_key_press","description":"\n\u003cp\u003eIf the caller doesn’t press a key, use the flow configured for no key press instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Key Press Flows","short_description":"Defines what happens when someone on a call presses a specific key, such as ending the call, moving to the next buyer, or applying a call disposition.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey_press_flow_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey_press\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_control_action_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_actions_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_disposition_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontinue_call_routing\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conference_time_elapsed_seconds_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eKey Press Flow Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press","full_name":"key_press","description":"\n\u003cp\u003eKey Press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"continue_call_routing","full_name":"continue_call_routing","description":"\n\u003cp\u003eWhen enabled, pressing this key while connected to an external agent hangs up the current buyer legs and searches for the next matching call flow to connect the lead to a real buyer, instead of running call_disposition_id and call_control_action_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n\u003cp\u003eThe disposition applied to the call when this key is pressed, instead of ending the call routing search.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_control_action_ids","full_name":"call_control_action_ids","description":"\n\u003cp\u003eThe actions to run when this key is pressed, instead of ending the call routing search.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Control Action}[/api/docs/1.0/call_control_actions/index.html]. Refer to: {/api/docs/1.0/call_control_actions}[/api/docs/1.0/call_control_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conference_time_elapsed_seconds_limit","full_name":"buyer_conference_time_elapsed_seconds_limit","description":"\n\u003cp\u003eOnly allows this key press once the buyer has been connected for at least this many seconds.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly uses this Key Press Flow for calls matching these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eWhen this Key Press Flow’s actions run, the call will be tagged with these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eKey Press Flow Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press","full_name":"key_press","description":"\n\u003cp\u003eKey Press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"continue_call_routing","full_name":"continue_call_routing","description":"\n\u003cp\u003eWhen enabled, pressing this key while connected to an external agent hangs up the current buyer legs and searches for the next matching call flow to connect the lead to a real buyer, instead of running call_disposition_id and call_control_action_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n\u003cp\u003eThe disposition applied to the call when this key is pressed, instead of ending the call routing search.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_control_action_ids","full_name":"call_control_action_ids","description":"\n\u003cp\u003eThe actions to run when this key is pressed, instead of ending the call routing search.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Control Action}[/api/docs/1.0/call_control_actions/index.html]. Refer to: {/api/docs/1.0/call_control_actions}[/api/docs/1.0/call_control_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conference_time_elapsed_seconds_limit","full_name":"buyer_conference_time_elapsed_seconds_limit","description":"\n\u003cp\u003eOnly allows this key press once the buyer has been connected for at least this many seconds.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly uses this Key Press Flow for calls matching these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eWhen this Key Press Flow’s actions run, the call will be tagged with these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eKey Press Flow Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press","full_name":"key_press","description":"\n\u003cp\u003eKey Press\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"continue_call_routing","full_name":"continue_call_routing","description":"\n\u003cp\u003eWhen enabled, pressing this key while connected to an external agent hangs up the current buyer legs and searches for the next matching call flow to connect the lead to a real buyer, instead of running call_disposition_id and call_control_action_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n\u003cp\u003eThe disposition applied to the call when this key is pressed, instead of ending the call routing search.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_control_action_ids","full_name":"call_control_action_ids","description":"\n\u003cp\u003eThe actions to run when this key is pressed, instead of ending the call routing search.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Call Control Action}[/api/docs/1.0/call_control_actions/index.html]. Refer to: {/api/docs/1.0/call_control_actions}[/api/docs/1.0/call_control_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conference_time_elapsed_seconds_limit","full_name":"buyer_conference_time_elapsed_seconds_limit","description":"\n\u003cp\u003eOnly allows this key press once the buyer has been connected for at least this many seconds.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly uses this Key Press Flow for calls matching these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eWhen this Key Press Flow’s actions run, the call will be tagged with these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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_action_logs":{"doc_url":"/api/docs/1.0/lead_action_logs","id":"lead_action_logs","api_url":"/api","name":"Lead Action Logs","short_description":"A billable record of each action a lead goes through, such as an email, webhook, or schedule step.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_action_logs/index","name":"index","apis":[{"api_url":"/api/v1/lead_action_logs","http_method":"GET","short_description":"List Lead Action Log records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nduration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncharged\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbillable_action\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_imports":{"doc_url":"/api/docs/1.0/lead_imports","id":"lead_imports","api_url":"/api","name":"Lead Import","short_description":"A CSV upload job that creates or updates leads for an offer or schedule from an uploaded file.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_maps_set\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_json\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nerror_message\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntotal_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstopped_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfailed_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsucceeded_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecent_calls_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_priority\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdate_only\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsub_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_buyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npause_leads\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nchange_next_action_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nset_next_action_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nset_next_action_time_zone\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_data_to_calls\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanage_move_to_another_schedule\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanage_move_to_another_schedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanage_add_to_schedule\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanage_add_to_schedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanage_delete_lead\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanage_schedule_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanage_opt_out_and_in\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanage_block_and_unblock\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":[{"name":"data_maps_attributes","full_name":"data_maps_attributes","description":"\n\u003cp\u003eHow the uploaded file’s columns fill in Trackdrive lead fields. Each entry maps one column: td_key is the Trackdrive field the column fills (for example caller_id or email), and ex_key is the column header in your uploaded file. One entry must map td_key caller_id or trackdrive_lead_id, and this mapping is what starts the import. [\u003c/p\u003e\n\n\u003cpre\u003e{ \u0026quot;td_key\u0026quot;: \u0026quot;caller_id\u0026quot;, \u0026quot;ex_key\u0026quot;: \u0026quot;Phone\u0026quot;, \u0026quot;import\u0026quot;: \u0026quot;1\u0026quot; },\n{ \u0026quot;td_key\u0026quot;: \u0026quot;email\u0026quot;, \u0026quot;ex_key\u0026quot;: \u0026quot;Email\u0026quot;, \u0026quot;import\u0026quot;: \u0026quot;1\u0026quot; }\u003c/pre\u003e\n\n\u003cp\u003e]\u003c/p\u003e\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":[],"deprecated":false}],"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":[{"name":"data_maps_attributes","full_name":"data_maps_attributes","description":"\n\u003cp\u003eHow the uploaded file’s columns fill in Trackdrive lead fields. Each entry maps one column: td_key is the Trackdrive field the column fills (for example caller_id or email), and ex_key is the column header in your uploaded file. One entry must map td_key caller_id or trackdrive_lead_id, and this mapping is what starts the import. [\u003c/p\u003e\n\n\u003cpre\u003e{ \u0026quot;td_key\u0026quot;: \u0026quot;caller_id\u0026quot;, \u0026quot;ex_key\u0026quot;: \u0026quot;Phone\u0026quot;, \u0026quot;import\u0026quot;: \u0026quot;1\u0026quot; },\n{ \u0026quot;td_key\u0026quot;: \u0026quot;email\u0026quot;, \u0026quot;ex_key\u0026quot;: \u0026quot;Email\u0026quot;, \u0026quot;import\u0026quot;: \u0026quot;1\u0026quot; }\u003c/pre\u003e\n\n\u003cp\u003e]\u003c/p\u003e\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":[],"deprecated":false}],"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_retarget_logs":{"doc_url":"/api/docs/1.0/lead_retarget_logs","id":"lead_retarget_logs","api_url":"/api","name":"Lead Retarget 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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_retarget_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noriginal_lead_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsuccess\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_retargets":{"doc_url":"/api/docs/1.0/lead_retargets","id":"lead_retargets","api_url":"/api","name":"Retarget","short_description":"Reprocesses a saved list of past leads through schedule actions again, optionally filtered by outcome or date.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_import_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_connected\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_source_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_owner_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nadd_to_schedule_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nadd_to_schedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_attempted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_call_disposition_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntotal_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nretarget_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\njobs_generated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsucceeded_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nform_step_actions_complete\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nform_steps\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprogress_percent\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_is_live\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsuccess_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_traffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_dial_tier_greater_than\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_dial_tier_less_than\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_opt_out\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_schedule_trigger_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata_source_schedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_created_at_from\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_created_at_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_attempted_from\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_attempted_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_connected_from\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_connected_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_converted_from\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_buyer_converted_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_call_disposition_ids_from\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscrub_call_disposition_ids_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_action_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_import_id","full_name":"lead_import_id","description":"\n\u003cp\u003eLead Import\u003c/p\u003e\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":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of this retarget, shown in your retarget list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause this retarget. A paused retarget will not process leads.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_type","full_name":"data_source_type","description":"\n\u003cp\u003eWhere to pull leads from: lead_import to retarget leads from an uploaded Lead Import, or schedule to retarget leads currently on a Schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003elead_import\u003c/code\u003e, \u003ccode\u003eschedule\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_schedule_id","full_name":"data_source_schedule_id","description":"\n\u003cp\u003eThe Schedule to pull leads from, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_created_at_from","full_name":"filter_created_at_from","description":"\n\u003cp\u003eOnly include leads created on or after this time, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_created_at_to","full_name":"filter_created_at_to","description":"\n\u003cp\u003eOnly include leads created on or before this time, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_owner_type","full_name":"filter_owner_type","description":"\n\u003cp\u003eOnly include leads owned by this type of record (Offer or Schedule), when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_schedule_trigger_type","full_name":"filter_schedule_trigger_type","description":"\n\u003cp\u003eOnly include leads whose end of schedule trigger matches this type, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_traffic_source_id","full_name":"filter_traffic_source_id","description":"\n\u003cp\u003eOnly include leads attributed to this Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"form_step_filter_complete","full_name":"form_step_filter_complete","description":"\n\u003cp\u003eWhether this retarget’s filter step has been completed. Must be true, along with form_step_actions_complete, for the retarget to run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"form_step_actions_complete","full_name":"form_step_actions_complete","description":"\n\u003cp\u003eWhether this retarget’s actions step has been completed. Must be true, along with form_step_filter_complete, for the retarget to run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_to_schedule_enabled","full_name":"add_to_schedule_enabled","description":"\n\u003cp\u003eAdd matching leads to add_to_schedule_id after this retarget’s actions run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_to_schedule_id","full_name":"add_to_schedule_id","description":"\n\u003cp\u003eThe Schedule to add matching leads to, when add_to_schedule_enabled is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"scrub_is_live","full_name":"scrub_is_live","description":"\n\u003cp\u003eExclude leads that are currently live (on an active call) from this retarget.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_opt_out","full_name":"scrub_opt_out","description":"\n\u003cp\u003eExclude leads whose contact has opted out from this retarget.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted","full_name":"scrub_buyer_attempted","description":"\n\u003cp\u003eExclude leads with a call that was attempted to a Buyer within the scrub_buyer_attempted_from/scrub_buyer_attempted_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted_from","full_name":"scrub_buyer_attempted_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_attempted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted_to","full_name":"scrub_buyer_attempted_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_attempted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected","full_name":"scrub_buyer_connected","description":"\n\u003cp\u003eExclude leads with a call that connected to a Buyer within the scrub_buyer_connected_from/scrub_buyer_connected_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected_from","full_name":"scrub_buyer_connected_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_connected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected_to","full_name":"scrub_buyer_connected_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_connected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted","full_name":"scrub_buyer_converted","description":"\n\u003cp\u003eExclude leads with a call that converted for a Buyer within the scrub_buyer_converted_from/scrub_buyer_converted_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted_from","full_name":"scrub_buyer_converted_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_converted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted_to","full_name":"scrub_buyer_converted_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_converted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids","full_name":"scrub_call_disposition_ids","description":"\n\u003cp\u003eExclude leads with a call matching any of these Call Dispositions within the scrub_call_disposition_ids_from/scrub_call_disposition_ids_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_from","full_name":"scrub_call_disposition_ids_from","description":"\n\u003cp\u003eThe start of the window used by scrub_call_disposition_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_to","full_name":"scrub_call_disposition_ids_to","description":"\n\u003cp\u003eThe end of the window used by scrub_call_disposition_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_import_id","full_name":"lead_import_id","description":"\n\u003cp\u003eLead Import\u003c/p\u003e\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":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of this retarget, shown in your retarget list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause this retarget. A paused retarget will not process leads.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_type","full_name":"data_source_type","description":"\n\u003cp\u003eWhere to pull leads from: lead_import to retarget leads from an uploaded Lead Import, or schedule to retarget leads currently on a Schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003elead_import\u003c/code\u003e, \u003ccode\u003eschedule\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_schedule_id","full_name":"data_source_schedule_id","description":"\n\u003cp\u003eThe Schedule to pull leads from, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_created_at_from","full_name":"filter_created_at_from","description":"\n\u003cp\u003eOnly include leads created on or after this time, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_created_at_to","full_name":"filter_created_at_to","description":"\n\u003cp\u003eOnly include leads created on or before this time, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_owner_type","full_name":"filter_owner_type","description":"\n\u003cp\u003eOnly include leads owned by this type of record (Offer or Schedule), when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_schedule_trigger_type","full_name":"filter_schedule_trigger_type","description":"\n\u003cp\u003eOnly include leads whose end of schedule trigger matches this type, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_traffic_source_id","full_name":"filter_traffic_source_id","description":"\n\u003cp\u003eOnly include leads attributed to this Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"form_step_filter_complete","full_name":"form_step_filter_complete","description":"\n\u003cp\u003eWhether this retarget’s filter step has been completed. Must be true, along with form_step_actions_complete, for the retarget to run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"form_step_actions_complete","full_name":"form_step_actions_complete","description":"\n\u003cp\u003eWhether this retarget’s actions step has been completed. Must be true, along with form_step_filter_complete, for the retarget to run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_to_schedule_enabled","full_name":"add_to_schedule_enabled","description":"\n\u003cp\u003eAdd matching leads to add_to_schedule_id after this retarget’s actions run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_to_schedule_id","full_name":"add_to_schedule_id","description":"\n\u003cp\u003eThe Schedule to add matching leads to, when add_to_schedule_enabled is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"scrub_is_live","full_name":"scrub_is_live","description":"\n\u003cp\u003eExclude leads that are currently live (on an active call) from this retarget.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_opt_out","full_name":"scrub_opt_out","description":"\n\u003cp\u003eExclude leads whose contact has opted out from this retarget.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted","full_name":"scrub_buyer_attempted","description":"\n\u003cp\u003eExclude leads with a call that was attempted to a Buyer within the scrub_buyer_attempted_from/scrub_buyer_attempted_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted_from","full_name":"scrub_buyer_attempted_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_attempted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted_to","full_name":"scrub_buyer_attempted_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_attempted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected","full_name":"scrub_buyer_connected","description":"\n\u003cp\u003eExclude leads with a call that connected to a Buyer within the scrub_buyer_connected_from/scrub_buyer_connected_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected_from","full_name":"scrub_buyer_connected_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_connected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected_to","full_name":"scrub_buyer_connected_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_connected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted","full_name":"scrub_buyer_converted","description":"\n\u003cp\u003eExclude leads with a call that converted for a Buyer within the scrub_buyer_converted_from/scrub_buyer_converted_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted_from","full_name":"scrub_buyer_converted_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_converted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted_to","full_name":"scrub_buyer_converted_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_converted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids","full_name":"scrub_call_disposition_ids","description":"\n\u003cp\u003eExclude leads with a call matching any of these Call Dispositions within the scrub_call_disposition_ids_from/scrub_call_disposition_ids_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_from","full_name":"scrub_call_disposition_ids_from","description":"\n\u003cp\u003eThe start of the window used by scrub_call_disposition_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_to","full_name":"scrub_call_disposition_ids_to","description":"\n\u003cp\u003eThe end of the window used by scrub_call_disposition_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_import_id","full_name":"lead_import_id","description":"\n\u003cp\u003eLead Import\u003c/p\u003e\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":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of this retarget, shown in your retarget list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause this retarget. A paused retarget will not process leads.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_type","full_name":"data_source_type","description":"\n\u003cp\u003eWhere to pull leads from: lead_import to retarget leads from an uploaded Lead Import, or schedule to retarget leads currently on a Schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003elead_import\u003c/code\u003e, \u003ccode\u003eschedule\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_schedule_id","full_name":"data_source_schedule_id","description":"\n\u003cp\u003eThe Schedule to pull leads from, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_created_at_from","full_name":"filter_created_at_from","description":"\n\u003cp\u003eOnly include leads created on or after this time, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_created_at_to","full_name":"filter_created_at_to","description":"\n\u003cp\u003eOnly include leads created on or before this time, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_owner_type","full_name":"filter_owner_type","description":"\n\u003cp\u003eOnly include leads owned by this type of record (Offer or Schedule), when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_schedule_trigger_type","full_name":"filter_schedule_trigger_type","description":"\n\u003cp\u003eOnly include leads whose end of schedule trigger matches this type, when data_source_type is schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_traffic_source_id","full_name":"filter_traffic_source_id","description":"\n\u003cp\u003eOnly include leads attributed to this Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"form_step_filter_complete","full_name":"form_step_filter_complete","description":"\n\u003cp\u003eWhether this retarget’s filter step has been completed. Must be true, along with form_step_actions_complete, for the retarget to run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"form_step_actions_complete","full_name":"form_step_actions_complete","description":"\n\u003cp\u003eWhether this retarget’s actions step has been completed. Must be true, along with form_step_filter_complete, for the retarget to run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_to_schedule_enabled","full_name":"add_to_schedule_enabled","description":"\n\u003cp\u003eAdd matching leads to add_to_schedule_id after this retarget’s actions run.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_to_schedule_id","full_name":"add_to_schedule_id","description":"\n\u003cp\u003eThe Schedule to add matching leads to, when add_to_schedule_enabled is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"scrub_is_live","full_name":"scrub_is_live","description":"\n\u003cp\u003eExclude leads that are currently live (on an active call) from this retarget.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_opt_out","full_name":"scrub_opt_out","description":"\n\u003cp\u003eExclude leads whose contact has opted out from this retarget.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted","full_name":"scrub_buyer_attempted","description":"\n\u003cp\u003eExclude leads with a call that was attempted to a Buyer within the scrub_buyer_attempted_from/scrub_buyer_attempted_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted_from","full_name":"scrub_buyer_attempted_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_attempted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_attempted_to","full_name":"scrub_buyer_attempted_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_attempted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected","full_name":"scrub_buyer_connected","description":"\n\u003cp\u003eExclude leads with a call that connected to a Buyer within the scrub_buyer_connected_from/scrub_buyer_connected_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected_from","full_name":"scrub_buyer_connected_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_connected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_connected_to","full_name":"scrub_buyer_connected_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_connected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted","full_name":"scrub_buyer_converted","description":"\n\u003cp\u003eExclude leads with a call that converted for a Buyer within the scrub_buyer_converted_from/scrub_buyer_converted_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted_from","full_name":"scrub_buyer_converted_from","description":"\n\u003cp\u003eThe start of the window used by scrub_buyer_converted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_buyer_converted_to","full_name":"scrub_buyer_converted_to","description":"\n\u003cp\u003eThe end of the window used by scrub_buyer_converted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids","full_name":"scrub_call_disposition_ids","description":"\n\u003cp\u003eExclude leads with a call matching any of these Call Dispositions within the scrub_call_disposition_ids_from/scrub_call_disposition_ids_to window.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_from","full_name":"scrub_call_disposition_ids_from","description":"\n\u003cp\u003eThe start of the window used by scrub_call_disposition_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_to","full_name":"scrub_call_disposition_ids_to","description":"\n\u003cp\u003eThe end of the window used by scrub_call_disposition_ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Groups","short_description":"A named collection of wait rules that a schedule matches against to calculate how long to pause a lead.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_wait_rules_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_wait_rule_ids","full_name":"lead_wait_rule_ids","description":"\n\u003cp\u003eLead Wait Rule Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_wait_rule_ids","full_name":"lead_wait_rule_ids","description":"\n\u003cp\u003eLead Wait Rule Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_wait_rule_ids","full_name":"lead_wait_rule_ids","description":"\n\u003cp\u003eLead Wait Rule Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Rules","short_description":"A rule that sets how long to pause a lead in a schedule, based on its recent call outcomes.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwait_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_call_disposition_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_call_disposition_two_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_two_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_two_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_two_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_wait_rule_group_ids\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_seconds","full_name":"wait_seconds","description":"\n\u003cp\u003eWait Seconds\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_call_disposition_ids","full_name":"filter_call_disposition_ids","description":"\n\u003cp\u003eCall Dispositions\u003c/p\u003e\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":[],"deprecated":false},{"name":"filter_call_disposition_two_ids","full_name":"filter_call_disposition_two_ids","description":"\n\u003cp\u003eCall Dispositions Two Calls Ago\u003c/p\u003e\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":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_id","full_name":"record_token_filter_two_id","description":"\n\u003cp\u003eRecord Token Filter Two\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_two_ids","full_name":"token_value_two_ids","description":"\n\u003cp\u003eToken Value Two Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eThe order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_wait_rule_group_ids","full_name":"lead_wait_rule_group_ids","description":"\n\u003cp\u003eAssign this rule to these Wait Rule Groups.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Lead Wait Rule Group}[/api/docs/1.0/lead_wait_rule_groups/index.html]. Refer to: {/api/docs/1.0/lead_wait_rule_groups}[/api/docs/1.0/lead_wait_rule_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_list","full_name":"record_token_filter_two_list","description":"\n\u003cp\u003eAssign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_seconds","full_name":"wait_seconds","description":"\n\u003cp\u003eWait Seconds\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_call_disposition_ids","full_name":"filter_call_disposition_ids","description":"\n\u003cp\u003eCall Dispositions\u003c/p\u003e\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":[],"deprecated":false},{"name":"filter_call_disposition_two_ids","full_name":"filter_call_disposition_two_ids","description":"\n\u003cp\u003eCall Dispositions Two Calls Ago\u003c/p\u003e\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":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_id","full_name":"record_token_filter_two_id","description":"\n\u003cp\u003eRecord Token Filter Two\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_two_ids","full_name":"token_value_two_ids","description":"\n\u003cp\u003eToken Value Two Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eThe order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_wait_rule_group_ids","full_name":"lead_wait_rule_group_ids","description":"\n\u003cp\u003eAssign this rule to these Wait Rule Groups.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Lead Wait Rule Group}[/api/docs/1.0/lead_wait_rule_groups/index.html]. Refer to: {/api/docs/1.0/lead_wait_rule_groups}[/api/docs/1.0/lead_wait_rule_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_list","full_name":"record_token_filter_two_list","description":"\n\u003cp\u003eAssign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_seconds","full_name":"wait_seconds","description":"\n\u003cp\u003eWait Seconds\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_call_disposition_ids","full_name":"filter_call_disposition_ids","description":"\n\u003cp\u003eCall Dispositions\u003c/p\u003e\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":[],"deprecated":false},{"name":"filter_call_disposition_two_ids","full_name":"filter_call_disposition_two_ids","description":"\n\u003cp\u003eCall Dispositions Two Calls Ago\u003c/p\u003e\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":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_id","full_name":"record_token_filter_two_id","description":"\n\u003cp\u003eRecord Token Filter Two\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_two_ids","full_name":"token_value_two_ids","description":"\n\u003cp\u003eToken Value Two Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eThe order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_wait_rule_group_ids","full_name":"lead_wait_rule_group_ids","description":"\n\u003cp\u003eAssign this rule to these Wait Rule Groups.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Lead Wait Rule Group}[/api/docs/1.0/lead_wait_rule_groups/index.html]. Refer to: {/api/docs/1.0/lead_wait_rule_groups}[/api/docs/1.0/lead_wait_rule_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_list","full_name":"record_token_filter_two_list","description":"\n\u003cp\u003eAssign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":{"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003elead\u003c/th\u003e\u003ctd\u003eLead\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_grid\u003c/th\u003e\u003ctd\u003eLead Grid\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_external\u003c/th\u003e\u003ctd\u003eLead External\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nemail\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfull_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexpires_in\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncountry\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstate_province\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzip_postal_code\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntime_zone\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsub_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhuman_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncss_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_next_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nopt_out\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npayout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_import_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nremote_ip\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempted_call_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnected_call_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscheduled_callback_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_buyer_conversion_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_offer_conversion_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsms_number_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndial_number_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndial_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_action_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfirst_action_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfirst_queued_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_ended_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnext_action_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_call_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_live\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_trigger_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nblocked\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_label","full_name":"created_at_label","description":"\n\u003cp\u003eDynamic Date String such as “Today” or “This Year”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eLast 5 Min\u003c/code\u003e, \u003ccode\u003eLast 15 Min\u003c/code\u003e, \u003ccode\u003eLast 30 Min\u003c/code\u003e, \u003ccode\u003eLast Hour\u003c/code\u003e, \u003ccode\u003eLast 4 Hours\u003c/code\u003e, \u003ccode\u003eLast 6 Hours\u003c/code\u003e, \u003ccode\u003eLast 12 Hours\u003c/code\u003e, \u003ccode\u003eLast Day\u003c/code\u003e, \u003ccode\u003eLast 2 Days\u003c/code\u003e, \u003ccode\u003eToday\u003c/code\u003e, \u003ccode\u003eYesterday\u003c/code\u003e, \u003ccode\u003eThis Week\u003c/code\u003e, \u003ccode\u003eLast Week\u003c/code\u003e, \u003ccode\u003eThis Month\u003c/code\u003e, \u003ccode\u003eLast Month\u003c/code\u003e, \u003ccode\u003eThis Quarter\u003c/code\u003e, \u003ccode\u003eLast Quarter\u003c/code\u003e, \u003ccode\u003eLast 6 Months\u003c/code\u003e, \u003ccode\u003eThis Year\u003c/code\u003e, \u003ccode\u003eLast Year\u003c/code\u003e, \u003ccode\u003eLifetime\u003c/code\u003e, \u003ccode\u003eCustom Range\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_action_at_to","full_name":"next_action_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_action_at_from","full_name":"next_action_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eSchedule internal id.\u003c/p\u003e\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":[],"deprecated":false},{"name":"contact_id","full_name":"contact_id","description":"\n\u003cp\u003eMatch calls that were placed by this caller.\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eRefer to the buyer api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eMatch results that have this status.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status_wait","full_name":"status_wait","description":"\n\u003cp\u003eFilter for leads that are waiting before performing an action.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number","full_name":"number","description":"\n\u003cp\u003eThe lead’s caller number. This is the number Trackdrive will dial when making outbound calls to the lead, and the number where Trackdrive will send SMS.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"has_next_action","full_name":"has_next_action","description":"\n\u003cp\u003eFilter for leads that have more actions to perform.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n\u003cp\u003eSelect leads that have converted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_converted","full_name":"offer_converted","description":"\n\u003cp\u003eSelect leads where a traffic source converted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"either_converted","full_name":"either_converted","description":"\n\u003cp\u003eSelect leads where either a buyer or traffic source converted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opt_out","full_name":"opt_out","description":"\n\u003cp\u003eSelect leads that have opted-out.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/show","name":"show","apis":[{"api_url":"/api/v1/leads/:id","http_method":"GET","short_description":"Get details about a lead.","deprecated":null}],"formats":null,"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 whether a lead has a buyer","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCheck if a lead has a potential buyer available that matches the lead’s filters.\u003c/p\u003e\n","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 caller number","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_number","full_name":"caller_number","description":"\n\u003cp\u003eFind the lead by this caller number.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":null,"full_description":"","errors":[],"params":[{"name":"contact_field_type","full_name":"contact_field_type","description":"\n\u003cp\u003ePass an ID belonging to an \u003ccode\u003eAgent Script \u0026amp; Field Type\u003c/code\u003e to select that \u003ccode\u003eCustom Contact Field Type\u003c/code\u003e for this call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id","full_name":"caller_id","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number","full_name":"number","description":"\n\u003cp\u003eThe lead’s caller number. This is the number Trackdrive will dial when making outbound calls to the lead, and the number where Trackdrive will send SMS.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked","full_name":"blocked","description":"\n\u003cp\u003eSet 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opt_out","full_name":"opt_out","description":"\n\u003cp\u003eSelect leads that have opted-out.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eUpdate the traffic source associated with this lead.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eReassign the lead to a different Schedule. Only takes effect when the lead is already owned by a Schedule; it does not move a lead between a Schedule and an Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eReassign the lead to a different Offer. Only takes effect when the lead is already owned by an Offer; it does not move a lead between an Offer and a Schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"expires_in","full_name":"expires_in","description":"\n\u003cp\u003eFor how many minutes should the lead stay in our database before it is automatically deleted? Leave this blank to set an infinite expiry. The default is to never delete leads.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_action_at","full_name":"next_action_at","description":"\n\u003cp\u003eChange 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_at","full_name":"schedule_callback_at","description":"\n\u003cp\u003eSchedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\n\u003cp\u003eSchedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_start","full_name":"schedule_start","description":"\n\u003cp\u003eAdds the lead back into the Schedule. Remaining actions will be performed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_stop","full_name":"schedule_stop","description":"\n\u003cp\u003eRemoves the lead from the Schedule. No further actions will be taken.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manual_schedule_restart","full_name":"manual_schedule_restart","description":"\n\u003cp\u003eWhen true, restarts the lead’s schedule from the beginning.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manual_opt_in","full_name":"manual_opt_in","description":"\n\u003cp\u003eWhen true, marks the lead as opted-in, allowing outbound actions (calls, SMS, emails) to resume.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manual_opt_out","full_name":"manual_opt_out","description":"\n\u003cp\u003eWhen true, marks the lead as opted-out, preventing outbound actions (calls, SMS, emails).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_in_seconds","full_name":"place_call_in_seconds","description":"\n\u003cp\u003ePlace an outbound call to the lead this many seconds from now. Use \u003ccode\u003e0\u003c/code\u003e to place the call immediately.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"move_to_another_schedule_id","full_name":"move_to_another_schedule_id","description":"\n\u003cp\u003eMove To Another Schedule - Assign matching leads to the selected schedule. Lead’s already on the selected schedule will restart their schedule.\u003c/p\u003e\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":[],"deprecated":false},{"name":"apply_to","full_name":"apply_to","description":"\n\u003cp\u003eShould the data you’re sending also be applied to calls associated with this lead?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecalls\u003c/code\u003e, \u003ccode\u003eself\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eTrackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. \u003ccode\u003e{interest: \u0026#39;kittens\u0026#39;, source: \u0026#39;google\u0026#39;, first_name: \u0026#39;John\u0026#39;, last_name: \u0026#39;Smith\u0026#39;}\u003c/code\u003e Emails and SMS also have access to these tokens, so it’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}}”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"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":null,"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\u003cp\u003eGroup or pivot the report by one of these lead attributes.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003estatus\u003c/th\u003e\u003ctd\u003eStatus\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_id\u003c/th\u003e\u003ctd\u003eOffer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_id\u003c/th\u003e\u003ctd\u003eSchedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_action_id\u003c/th\u003e\u003ctd\u003eSchedule Action\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_converted_schedule_action_id\u003c/th\u003e\u003ctd\u003eThe schedule action where the lead converted.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_import_id\u003c/th\u003e\u003ctd\u003eLead Import\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etraffic_source_id\u003c/th\u003e\u003ctd\u003eTraffic Source\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoutbound_calls_count\u003c/th\u003e\u003ctd\u003eOutbound Calls Count\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003einbound_calls_count\u003c/th\u003e\u003ctd\u003eInbound Calls Count\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erecent_call_disposition_id\u003c/th\u003e\u003ctd\u003eRecent Call Disposition\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_converted_days\u003c/th\u003e\u003ctd\u003eBuyer Converted Days\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_id\u003c/th\u003e\u003ctd\u003eBuyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecountry\u003c/th\u003e\u003ctd\u003eCountry\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_center_id\u003c/th\u003e\u003ctd\u003eCall Center\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003estate\u003c/th\u003e\u003ctd\u003eState\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003esub_id\u003c/th\u003e\u003ctd\u003eSub ID\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003edial_tier\u003c/th\u003e\u003ctd\u003eDial Tier\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact_field_type\u003c/th\u003e\u003ctd\u003eContact Field Type\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_day\u003c/th\u003e\u003ctd\u003eThe day the lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_month\u003c/th\u003e\u003ctd\u003eThe month the lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_week\u003c/th\u003e\u003ctd\u003eThe week the lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_five_minutes\u003c/th\u003e\u003ctd\u003eThe minute the lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_hour\u003c/th\u003e\u003ctd\u003eThe hour lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_trigger_type\u003c/th\u003e\u003ctd\u003eSchedule Trigger Type\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_postal_code\u003c/th\u003e\u003ctd\u003eZip/Postal Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecountry\u003c/th\u003e\u003ctd\u003eCountry\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003estate_province\u003c/th\u003e\u003ctd\u003eState/Province\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etoken_values_map\u003c/th\u003e\u003ctd\u003eToken Values Map\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pivot","full_name":"pivot","description":"\n\u003cp\u003eGroup or pivot the report by one of these lead attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003estatus\u003c/th\u003e\u003ctd\u003eStatus\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_id\u003c/th\u003e\u003ctd\u003eOffer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_id\u003c/th\u003e\u003ctd\u003eSchedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_action_id\u003c/th\u003e\u003ctd\u003eSchedule Action\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_converted_schedule_action_id\u003c/th\u003e\u003ctd\u003eThe schedule action where the lead converted.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003elead_import_id\u003c/th\u003e\u003ctd\u003eLead Import\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etraffic_source_id\u003c/th\u003e\u003ctd\u003eTraffic Source\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoutbound_calls_count\u003c/th\u003e\u003ctd\u003eOutbound Calls Count\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003einbound_calls_count\u003c/th\u003e\u003ctd\u003eInbound Calls Count\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erecent_call_disposition_id\u003c/th\u003e\u003ctd\u003eRecent Call Disposition\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_converted_days\u003c/th\u003e\u003ctd\u003eBuyer Converted Days\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_id\u003c/th\u003e\u003ctd\u003eBuyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecountry\u003c/th\u003e\u003ctd\u003eCountry\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecall_center_id\u003c/th\u003e\u003ctd\u003eCall Center\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003estate\u003c/th\u003e\u003ctd\u003eState\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003esub_id\u003c/th\u003e\u003ctd\u003eSub ID\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003edial_tier\u003c/th\u003e\u003ctd\u003eDial Tier\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econtact_field_type\u003c/th\u003e\u003ctd\u003eContact Field Type\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_day\u003c/th\u003e\u003ctd\u003eThe day the lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_month\u003c/th\u003e\u003ctd\u003eThe month the lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_week\u003c/th\u003e\u003ctd\u003eThe week the lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_five_minutes\u003c/th\u003e\u003ctd\u003eThe minute the lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecreated_at_hour\u003c/th\u003e\u003ctd\u003eThe hour lead was submitted\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_trigger_type\u003c/th\u003e\u003ctd\u003eSchedule Trigger Type\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_postal_code\u003c/th\u003e\u003ctd\u003eZip/Postal Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecountry\u003c/th\u003e\u003ctd\u003eCountry\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003estate_province\u003c/th\u003e\u003ctd\u003eState/Province\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etoken_values_map\u003c/th\u003e\u003ctd\u003eToken Values Map\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nemail\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfull_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexpires_in\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncountry\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstate_province\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzip_postal_code\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntime_zone\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsub_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhuman_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncss_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_next_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nopt_out\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npayout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_converted\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_import_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nremote_ip\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattempted_call_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnected_call_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nscheduled_callback_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_buyer_conversion_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_offer_conversion_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsms_number_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndial_number_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndial_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_action_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfirst_action_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfirst_queued_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_ended_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnext_action_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_call_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_live\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_trigger_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nblocked\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"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":null,"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id","full_name":"caller_id","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_type","full_name":"contact_field_type","description":"\n\u003cp\u003ePass an ID belonging to an \u003ccode\u003eAgent Script \u0026amp; Field Type\u003c/code\u003e to select that \u003ccode\u003eCustom Contact Field Type\u003c/code\u003e for this call.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_at","full_name":"schedule_callback_at","description":"\n\u003cp\u003eSchedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\n\u003cp\u003eSchedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"update_all_matching_leads","full_name":"update_all_matching_leads","description":"\n\u003cp\u003eIf 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)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_to","full_name":"apply_to","description":"\n\u003cp\u003eShould the data you’re sending also be applied to calls associated with this lead?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecalls\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unblock_contact","full_name":"unblock_contact","description":"\n\u003cp\u003eRemove the caller_id from the company blacklist. Usage of this param requires passing an auth_token with permission to update Leads.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked","full_name":"blocked","description":"\n\u003cp\u003eSet 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_trackdrive_number","full_name":"assign_trackdrive_number","description":"\n\u003cp\u003eAssign a dialing number and return it in the API response as trackdrive_number_plain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_sms_number","full_name":"assign_sms_number","description":"\n\u003cp\u003eAssign an SMS number and return it in the API response as sms_number_plain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expire_existing","full_name":"expire_existing","description":"\n\u003cp\u003eExpire existing live schedule leads that match the lead_token and caller_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_existing","full_name":"delete_existing","description":"\n\u003cp\u003eDelete existing leads that match the lead_token and caller_id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"update_only","full_name":"update_only","description":"\n\u003cp\u003eOnly 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_priority","full_name":"lead_priority","description":"\n\u003cp\u003eDefines the lead’s priority for processing. Leads with lower values are processed first, influencing the order of scheduled actions such as calls, SMS, emails, and more.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restart_schedule","full_name":"restart_schedule","description":"\n\u003cp\u003eRestart the schedule for the lead from the beginning.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_format_nested_fields","full_name":"auto_format_nested_fields","description":"\n\u003cp\u003eAutomatically extract contact fields that are nested inside non-standard incoming POST.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_action_at","full_name":"next_action_at","description":"\n\u003cp\u003eChange 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hours_to_expire","full_name":"hours_to_expire","description":"\n\u003cp\u003eExpire the lead after this many hours. The lead will exit schedule and perform end of schedule actions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_contact_attempts","full_name":"max_contact_attempts","description":"\n\u003cp\u003eExpire the lead after this many outbound calls + SMS. The lead will exit schedule and perform end of schedule actions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eTrackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. \u003ccode\u003e{interest: \u0026#39;kittens\u0026#39;, source: \u0026#39;google\u0026#39;, first_name: \u0026#39;John\u0026#39;, last_name: \u0026#39;Smith\u0026#39;}\u003c/code\u003e Emails and SMS also have access to these tokens, so it’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}}”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source this lead came from, as its Trackdrive id or the traffic source id you gave it (user_traffic_source_id).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opt_out","full_name":"opt_out","description":"\n\u003cp\u003eMark the lead as opt-out or opt-in. Opt-out prevents outbound calls, SMS, and email to this caller, but still allows them to dial in to resubscribe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_caller_permission_required","full_name":"contact_caller_permission_required","description":"\n\u003cp\u003eWhether this caller has given permission to be contacted, as required by your compliance settings.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/create_or_update","name":"create_or_update","apis":[{"api_url":"/api/v1/leads/create_or_update","http_method":"POST","short_description":"Create or update a lead","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreate a new lead if no active lead exists on the offer, or update the existing active lead.\u003c/p\u003e\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id","full_name":"caller_id","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_type","full_name":"contact_field_type","description":"\n\u003cp\u003ePass an ID belonging to an \u003ccode\u003eAgent Script \u0026amp; Field Type\u003c/code\u003e to select that \u003ccode\u003eCustom Contact Field Type\u003c/code\u003e for this call.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_at","full_name":"schedule_callback_at","description":"\n\u003cp\u003eSchedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\n\u003cp\u003eSchedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"update_all_matching_leads","full_name":"update_all_matching_leads","description":"\n\u003cp\u003eIf 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)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_to","full_name":"apply_to","description":"\n\u003cp\u003eShould the data you’re sending also be applied to calls associated with this lead?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecalls\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_trackdrive_number","full_name":"assign_trackdrive_number","description":"\n\u003cp\u003eAssign a dialing number and return it in the API response as trackdrive_number_plain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_sms_number","full_name":"assign_sms_number","description":"\n\u003cp\u003eAssign an SMS number and return it in the API response as sms_number_plain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_priority","full_name":"lead_priority","description":"\n\u003cp\u003eDefines the lead’s priority for processing. Leads with lower values are processed first, influencing the order of scheduled actions such as calls, SMS, emails, and more.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restart_schedule","full_name":"restart_schedule","description":"\n\u003cp\u003eRestart the schedule for the lead from the beginning.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_format_nested_fields","full_name":"auto_format_nested_fields","description":"\n\u003cp\u003eAutomatically extract contact fields that are nested inside non-standard incoming POST.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_action_at","full_name":"next_action_at","description":"\n\u003cp\u003eChange 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hours_to_expire","full_name":"hours_to_expire","description":"\n\u003cp\u003eExpire the lead after this many hours. The lead will exit schedule and perform end of schedule actions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_contact_attempts","full_name":"max_contact_attempts","description":"\n\u003cp\u003eExpire the lead after this many outbound calls + SMS. The lead will exit schedule and perform end of schedule actions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eTrackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. \u003ccode\u003e{interest: \u0026#39;kittens\u0026#39;, source: \u0026#39;google\u0026#39;, first_name: \u0026#39;John\u0026#39;, last_name: \u0026#39;Smith\u0026#39;}\u003c/code\u003e Emails and SMS also have access to these tokens, so it’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}}”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source this lead came from, as its Trackdrive id or the traffic source id you gave it (user_traffic_source_id).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opt_out","full_name":"opt_out","description":"\n\u003cp\u003eMark the lead as opt-out or opt-in. Opt-out prevents outbound calls, SMS, and email to this caller, but still allows them to dial in to resubscribe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_caller_permission_required","full_name":"contact_caller_permission_required","description":"\n\u003cp\u003eWhether this caller has given permission to be contacted, as required by your compliance settings.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"Opt out a lead by caller ID","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eMark a single lead as opt-out. Opted-out leads will no longer be sent SMS, Calls, or Emails.\u003c/p\u003e\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["\ncurl -X PUT -d '' trackdrive.com/api/v1/leads/17194977450/caller_opt_out?lead_token=yourtoken\n\n# GET requests are supported\ncurl trackdrive.com/api/v1/leads/17194977450/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 lead by caller ID","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove a single lead from a Schedule or Offer. This will prevent ANY additional actions being taken on behalf of the lead.\u003c/p\u003e\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"Requeue a lead by caller ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/lead_update","name":"lead_update","apis":[{"api_url":"/api/v1/leads/:lead_id/lead_update","http_method":"POST","short_description":"Update a lead by lead ID","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate one specific lead by its Trackdrive lead id. Unlike the caller_id endpoints, only the lead you name is changed.\u003c/p\u003e\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eThe Trackdrive lead id (uuid) returned in the response when the lead was submitted. Identifies exactly one lead, so updates never touch another lead that shares the same caller_id.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_type","full_name":"contact_field_type","description":"\n\u003cp\u003ePass an ID belonging to an \u003ccode\u003eAgent Script \u0026amp; Field Type\u003c/code\u003e to select that \u003ccode\u003eCustom Contact Field Type\u003c/code\u003e for this call.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_at","full_name":"schedule_callback_at","description":"\n\u003cp\u003eSchedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\n\u003cp\u003eSchedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"update_all_matching_leads","full_name":"update_all_matching_leads","description":"\n\u003cp\u003eIf 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)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_to","full_name":"apply_to","description":"\n\u003cp\u003eShould the data you’re sending also be applied to calls associated with this lead?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecalls\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unblock_contact","full_name":"unblock_contact","description":"\n\u003cp\u003eRemove the caller_id from the company blacklist. Usage of this param requires passing an auth_token with permission to update Leads.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked","full_name":"blocked","description":"\n\u003cp\u003eSet 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_trackdrive_number","full_name":"assign_trackdrive_number","description":"\n\u003cp\u003eAssign a dialing number and return it in the API response as trackdrive_number_plain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_sms_number","full_name":"assign_sms_number","description":"\n\u003cp\u003eAssign an SMS number and return it in the API response as sms_number_plain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_priority","full_name":"lead_priority","description":"\n\u003cp\u003eDefines the lead’s priority for processing. Leads with lower values are processed first, influencing the order of scheduled actions such as calls, SMS, emails, and more.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"restart_schedule","full_name":"restart_schedule","description":"\n\u003cp\u003eRestart the schedule for the lead from the beginning.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_format_nested_fields","full_name":"auto_format_nested_fields","description":"\n\u003cp\u003eAutomatically extract contact fields that are nested inside non-standard incoming POST.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_action_at","full_name":"next_action_at","description":"\n\u003cp\u003eChange 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hours_to_expire","full_name":"hours_to_expire","description":"\n\u003cp\u003eExpire the lead after this many hours. The lead will exit schedule and perform end of schedule actions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_contact_attempts","full_name":"max_contact_attempts","description":"\n\u003cp\u003eExpire the lead after this many outbound calls + SMS. The lead will exit schedule and perform end of schedule actions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eTrackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. \u003ccode\u003e{interest: \u0026#39;kittens\u0026#39;, source: \u0026#39;google\u0026#39;, first_name: \u0026#39;John\u0026#39;, last_name: \u0026#39;Smith\u0026#39;}\u003c/code\u003e Emails and SMS also have access to these tokens, so it’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}}”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source this lead came from, as its Trackdrive id or the traffic source id you gave it (user_traffic_source_id).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"opt_out","full_name":"opt_out","description":"\n\u003cp\u003eMark the lead as opt-out or opt-in. Opt-out prevents outbound calls, SMS, and email to this caller, but still allows them to dial in to resubscribe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_caller_permission_required","full_name":"contact_caller_permission_required","description":"\n\u003cp\u003eWhether this caller has given permission to be contacted, as required by your compliance settings.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/lead_opt_out","name":"lead_opt_out","apis":[{"api_url":"/api/v1/leads/:lead_id/lead_opt_out","http_method":"PUT","short_description":"Opt out a lead by lead ID","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eMark a lead as opt-out by its Trackdrive lead id. Opted-out leads will no longer be sent SMS, Calls, or Emails. Opt-out applies to the contact, so every lead sharing that caller_id is opted out.\u003c/p\u003e\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eThe Trackdrive lead id (uuid) returned in the response when the lead was submitted. Identifies exactly one lead, so updates never touch another lead that shares the same caller_id.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":["\ncurl -X PUT -d '' trackdrive.com/api/v1/leads/74da9151-d988-4428-8087-c8dcf47ae9a2/lead_opt_out?lead_token=yourtoken\n\n# The lead id can also be passed as a param:\ncurl -X PUT -d '' trackdrive.com/api/v1/leads/lead_opt_out?lead_token=yourtoken\u0026lead_id=74da9151-d988-4428-8087-c8dcf47ae9a2"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/lead_remove","name":"lead_remove","apis":[{"api_url":"/api/v1/leads/:lead_id/lead_remove","http_method":"POST","short_description":"Remove a lead by lead ID","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove one specific lead from a Schedule or Offer by its Trackdrive lead id. This will prevent ANY additional actions being taken on behalf of the lead.\u003c/p\u003e\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eThe Trackdrive lead id (uuid) returned in the response when the lead was submitted. Identifies exactly one lead, so updates never touch another lead that shares the same caller_id.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/lead_move_to_end_of_schedule","name":"lead_move_to_end_of_schedule","apis":[{"api_url":"/api/v1/leads/:lead_id/lead_move_to_end_of_schedule","http_method":"PUT","short_description":"Requeue a lead by lead ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe 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.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eThe Trackdrive lead id (uuid) returned in the response when the lead was submitted. Identifies exactly one lead, so updates never touch another lead that shares the same caller_id.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"mitigation_numbers":{"doc_url":"/api/docs/1.0/mitigation_numbers","id":"mitigation_numbers","api_url":"/api","name":"Mitigation Numbers","short_description":"Manage spam-tag mitigation and branded caller ID for your phone numbers. Enabling a number registers it with the mobile carriers to remove \"Spam Likely\" labels; setting a branded name displays your business name as the caller ID on outbound calls. A one-time business compliance profile must be completed before numbers can be enabled; carriers approve the business in 1-3 business days, then approve each submitted number in about 2-3 weeks.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/mitigation_numbers/index","name":"index","apis":[{"api_url":"/api/v1/mitigation_numbers","http_method":"GET","short_description":"List mitigation numbers","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eList the mitigation numbers in your account. Each row includes the per-carrier reputation reported by T-Mobile, Verizon, and AT\u0026amp;T (displayed caller ID and whether the number is currently spam-flagged), the branded name, and the carrier approval status.\u003c/p\u003e\n","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrackdrive_number_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbranded_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napproved\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_synced_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrackdrive_number_state\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntmobile_caller_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nverizon_caller_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\natt_caller_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntmobile_is_spam\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nverizon_is_spam\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\natt_is_spam\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmitigation_organization_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\norganization_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\norganization_approval_status\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/mitigation_numbers/update","name":"update","apis":[{"api_url":"/api/v1/mitigation_numbers/:id","http_method":"PUT","short_description":"Update a number's spam-tag mitigation","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eEnable or disable spam-tag mitigation, or set the branded name, for a number.\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe id of the mitigation number to update.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhether spam-tag mitigation is active for this number. Enabling registers the number with the mobile carriers for spam-label removal; carriers typically take 2-3 weeks to approve a submitted number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"branded_name","full_name":"branded_name","description":"\n\u003cp\u003eThe business name shown as branded caller ID. Calls placed from a number with a branded name are billed per call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/mitigation_numbers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/mitigation_numbers/:id","http_method":"DELETE","short_description":"Remove a number from spam-tag mitigation","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove a number from spam-tag mitigation. Deactivates the number with the carriers, then soft-deletes it. Use this to remove numbers that are not hosted on TrackDrive.\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe id of the mitigation number to update.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Prefixes","short_description":"Phone number area codes or prefixes requested within a number order, with how many numbers to buy for each.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_order_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprefix\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\norder_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_statuses\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eNumber Order\u003c/p\u003e\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":[],"deprecated":false},{"name":"prefix","full_name":"prefix","description":"\n\u003cp\u003ePrefix\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_count","full_name":"order_count","description":"\n\u003cp\u003eOrder Count\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eSortable Order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eNumber Order\u003c/p\u003e\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":[],"deprecated":false},{"name":"prefix","full_name":"prefix","description":"\n\u003cp\u003ePrefix\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_count","full_name":"order_count","description":"\n\u003cp\u003eOrder Count\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eSortable Order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eNumber Order\u003c/p\u003e\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":[],"deprecated":false},{"name":"prefix","full_name":"prefix","description":"\n\u003cp\u003ePrefix\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_count","full_name":"order_count","description":"\n\u003cp\u003eOrder Count\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eSortable Order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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 Orders","short_description":"Bulk requests to purchase new tracking numbers from a provider for an offer, pool, traffic source or schedule.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_configuration_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfallback_to_any_number_in_state\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_order_prefix_ids\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eThe offer the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eThe number pool the ordered numbers will be added to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of the number order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA description of the number order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eThe provider the numbers will be purchased from.\u003c/p\u003e\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":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause the order so it stops purchasing numbers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fallback_to_any_number_in_state","full_name":"fallback_to_any_number_in_state","description":"\n\u003cp\u003eWhen no number is available with the requested prefix, allow purchasing any available number in the same state.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eThe offer the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eThe number pool the ordered numbers will be added to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of the number order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA description of the number order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eThe provider the numbers will be purchased from.\u003c/p\u003e\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":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause the order so it stops purchasing numbers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fallback_to_any_number_in_state","full_name":"fallback_to_any_number_in_state","description":"\n\u003cp\u003eWhen no number is available with the requested prefix, allow purchasing any available number in the same state.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eThe offer the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eThe number pool the ordered numbers will be added to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule the ordered numbers will be assigned to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of the number order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA description of the number order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eThe provider the numbers will be purchased from.\u003c/p\u003e\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":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause the order so it stops purchasing numbers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fallback_to_any_number_in_state","full_name":"fallback_to_any_number_in_state","description":"\n\u003cp\u003eWhen no number is available with the requested prefix, allow purchasing any available number in the same state.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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},"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":"Rules that detect if a call was answered by a machine or a human and change how the call is routed accordingly.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_value_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nai_classification_matches\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nai_speech_text_matches\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\napply_detected_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eThe offer this AMD Flow belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA description of the AMD Flow.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eOnly apply this AMD Flow to calls matching these filters.\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly apply this AMD Flow to calls matching these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\n\u003cp\u003eIf Classification Matches\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_speech_text_matches","full_name":"ai_speech_text_matches","description":"\n\u003cp\u003eOr if Speech To Text Matches\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_detected_type","full_name":"apply_detected_type","description":"\n\u003cp\u003eThen 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eThe offer this AMD Flow belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA description of the AMD Flow.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eOnly apply this AMD Flow to calls matching these filters.\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly apply this AMD Flow to calls matching these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\n\u003cp\u003eIf Classification Matches\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_speech_text_matches","full_name":"ai_speech_text_matches","description":"\n\u003cp\u003eOr if Speech To Text Matches\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_detected_type","full_name":"apply_detected_type","description":"\n\u003cp\u003eThen 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eThe offer this AMD Flow belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA description of the AMD Flow.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eOnly apply this AMD Flow to calls matching these filters.\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly apply this AMD Flow to calls matching these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\n\u003cp\u003eIf Classification Matches\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_speech_text_matches","full_name":"ai_speech_text_matches","description":"\n\u003cp\u003eOr if Speech To Text Matches\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apply_detected_type","full_name":"apply_detected_type","description":"\n\u003cp\u003eThen 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Conversions Settings","short_description":"Rules that define when and how much a traffic source is paid when one of its calls converts.","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 Traffic Source Payouts.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eThe Offer this conversion rule belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"business_range_id","full_name":"business_range_id","description":"\n\u003cp\u003eScopes this conversion rule to calls during this Business Range, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days \u0026 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":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npayout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npayout_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrevenue_percentage\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nduration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nduplicate_timeframe\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nduplicate_timeframe_scope\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_values\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbusiness_range_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconversion_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Traffic Source Payout by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Traffic Source Payout.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payout_type","full_name":"payout_type","description":"\n\u003cp\u003ePayout Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eusd\u003c/code\u003e, \u003ccode\u003ebuyer_conversion_percent\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payout","full_name":"payout","description":"\n\u003cp\u003ePayout\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_percentage","full_name":"revenue_percentage","description":"\n\u003cp\u003eRevenue Percentage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"duration","full_name":"duration","description":"\n\u003cp\u003eDuration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\n\u003cp\u003eDuplicate Timeframe\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"duplicate_timeframe_scope","full_name":"duplicate_timeframe_scope","description":"\n\u003cp\u003eDuplicate Timeframe Scope\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eoffer\u003c/code\u003e, \u003ccode\u003etraffic_source\u003c/code\u003e, \u003ccode\u003enumber\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eThe Offer this conversion rule belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"business_range_id","full_name":"business_range_id","description":"\n\u003cp\u003eScopes this conversion rule to calls during this Business Range, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days \u0026 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":[],"deprecated":false},{"name":"conversion_type","full_name":"conversion_type","description":"\n\u003cp\u003eWhen the traffic source is paid: payout (after Duration seconds), postback (an external conversion postback), or when_buyer_converted (when a buyer converts the call).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epayout\u003c/code\u003e, \u003ccode\u003epostback\u003c/code\u003e, \u003ccode\u003ewhen_buyer_converted\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eScopes this conversion rule to calls from this Traffic Source, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eScopes this conversion rule to calls to this Number, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"\n\u003cp\u003eThe id of the record given in owner_type that this conversion rule is scoped to, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"owner_type","full_name":"owner_type","description":"\n\u003cp\u003eWhat this conversion rule is scoped to instead of the whole Offer: TrafficSource, Number, or BusinessRange, used together with owner_id.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly pays out for calls matching these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eSortable Order\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/update","name":"update","apis":[{"api_url":"/api/v1/offer_conversions/:id","http_method":"PUT","short_description":"Update Traffic Source Payout by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payout_type","full_name":"payout_type","description":"\n\u003cp\u003ePayout Type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eusd\u003c/code\u003e, \u003ccode\u003ebuyer_conversion_percent\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payout","full_name":"payout","description":"\n\u003cp\u003ePayout\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue_percentage","full_name":"revenue_percentage","description":"\n\u003cp\u003eRevenue Percentage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"duration","full_name":"duration","description":"\n\u003cp\u003eDuration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\n\u003cp\u003eDuplicate Timeframe\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"duplicate_timeframe_scope","full_name":"duplicate_timeframe_scope","description":"\n\u003cp\u003eDuplicate Timeframe Scope\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eoffer\u003c/code\u003e, \u003ccode\u003etraffic_source\u003c/code\u003e, \u003ccode\u003enumber\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eThe Offer this conversion rule belongs to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"business_range_id","full_name":"business_range_id","description":"\n\u003cp\u003eScopes this conversion rule to calls during this Business Range, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days \u0026 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":[],"deprecated":false},{"name":"conversion_type","full_name":"conversion_type","description":"\n\u003cp\u003eWhen the traffic source is paid: payout (after Duration seconds), postback (an external conversion postback), or when_buyer_converted (when a buyer converts the call).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003epayout\u003c/code\u003e, \u003ccode\u003epostback\u003c/code\u003e, \u003ccode\u003ewhen_buyer_converted\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eScopes this conversion rule to calls from this Traffic Source, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eScopes this conversion rule to calls to this Number, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"\n\u003cp\u003eThe id of the record given in owner_type that this conversion rule is scoped to, instead of the whole Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"owner_type","full_name":"owner_type","description":"\n\u003cp\u003eWhat this conversion rule is scoped to instead of the whole Offer: TrafficSource, Number, or BusinessRange, used together with owner_id.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly pays out for calls matching these token values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eSortable Order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/offer_conversions/:id","http_method":"DELETE","short_description":"Destroy Traffic Source Payout by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_conversion_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"The set of offers in your account.","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\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003eschedules_count\u003c/code\u003e, \u003ccode\u003enumbers_count\u003c/code\u003e, \u003ccode\u003ebuyers_count\u003c/code\u003e, \u003ccode\u003eagents_count\u003c/code\u003e, \u003ccode\u003epaused\u003c/code\u003e, \u003ccode\u003euser_offer_id\u003c/code\u003e, \u003ccode\u003ecalls_count\u003c/code\u003e, \u003ccode\u003erecent_calls_count\u003c/code\u003e, \u003ccode\u003elast_call_at\u003c/code\u003e, \u003ccode\u003enumbers_count\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_offer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_api_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nleads_api_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_cc_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nactive_cc_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nin_progress_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_routers_attributes\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_token\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_conversion_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_groups_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagents_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvertical_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvertical_options\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_blacklist_alliance_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_blacklist_alliance_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_blacklist_alliance_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_tcpa_shield_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_tcpa_shield_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_tcpa_shield_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_suppression_list_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_suppression_list_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_suppression_list_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eGive this offer a name. Example: Insurance Calls\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_offer_id","full_name":"user_offer_id","description":"\n\u003cp\u003eGive this offer a unique ID. Example: IC001\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of the record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause the offer. Paused offers will reject all calls and disable all schedules.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls","full_name":"record_calls","description":"\n\u003cp\u003eRecord Calls\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls_require_authorization","full_name":"record_calls_require_authorization","description":"\n\u003cp\u003eRequire the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_id","full_name":"vertical_id","description":"\n\u003cp\u003eThe Vertical assigned to this offer, used for reporting and Vertical-scoped enrichment.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"callback_behaviour","full_name":"callback_behaviour","description":"\n\u003cp\u003eHow a caller who calls back the same offer is routed. One of \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003eforce_previous_buyer\u003c/code\u003e, or \u003ccode\u003eforce_new_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enormal\u003c/th\u003e\u003ctd\u003eNormal\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eforce_previous_buyer\u003c/th\u003e\u003ctd\u003eForce Previous Buyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eforce_new_buyer\u003c/th\u003e\u003ctd\u003eForce New Buyer\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_timeframe","full_name":"callback_reconnect_timeframe","description":"\n\u003cp\u003eThe number of seconds after a call ends during which a callback is still treated as a repeat call for routing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_buyer_ids","full_name":"callback_reconnect_buyer_ids","description":"\n\u003cp\u003eThe buyer IDs eligible to receive a reconnected callback. If blank, no buyers are reconnected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_behaviour","full_name":"callback_reconnect_behaviour","description":"\n\u003cp\u003eThe action taken once the reconnect timeframe has passed, for example \u003ccode\u003eforce_new_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_anonymous_ignore_duplicate_timeframe","full_name":"callback_anonymous_ignore_duplicate_timeframe","description":"\n\u003cp\u003eWhen true, calls from anonymous caller IDs are treated as unique calls instead of being matched to a previous call for the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_without_dupe","full_name":"callback_reconnect_without_dupe","description":"\n\u003cp\u003eWhen true, a call is not sent to a buyer who already converted a call from the same caller within the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_without_repeat","full_name":"callback_reconnect_without_repeat","description":"\n\u003cp\u003eWhen true, a call is not sent to a buyer who already answered a call from the same caller within the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_contact_field_validations","full_name":"enforce_contact_field_validations","description":"\n\u003cp\u003eWhen true, leads submitted to this offer must pass the offer’s contact field validations before they are accepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eWhen true, a lead submitted to this offer must include a \u003ccode\u003etraffic_source_id\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_traffic_source_reject_duplicates","full_name":"lead_traffic_source_reject_duplicates","description":"\n\u003cp\u003eWhen true, a lead is rejected if it duplicates an existing lead from the same traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_lead_contact_field_keys","full_name":"enforce_lead_contact_field_keys","description":"\n\u003cp\u003eWhen true, only the contact field keys configured on this offer are accepted on lead submission.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minimum_caller_number_length","full_name":"minimum_caller_number_length","description":"\n\u003cp\u003eThe minimum number of digits accepted in an inbound caller’s phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_caller_number_length","full_name":"maximum_caller_number_length","description":"\n\u003cp\u003eThe maximum number of digits accepted in an inbound caller’s phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n\u003cp\u003eThe Map Contact Field Groups applied to leads submitted to this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Contact Field Mapping Group}[/api/docs/1.0/map_contact_field_groups/index.html]. Refer to: {/api/docs/1.0/map_contact_field_groups}[/api/docs/1.0/map_contact_field_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_expire_in_months","full_name":"leads_expire_in_months","description":"\n\u003cp\u003eThe number of months a lead remains active before it is automatically archived and removed from delivery.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003eWhen true, this offer’s public posting instructions page is reachable at its posting instructions link.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eWhen true, this offer is listed on the public posting instructions index page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe title shown on this offer’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe HTML description shown on this offer’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eGive this offer a name. Example: Insurance Calls\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_offer_id","full_name":"user_offer_id","description":"\n\u003cp\u003eGive this offer a unique ID. Example: IC001\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of the record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause the offer. Paused offers will reject all calls and disable all schedules.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls","full_name":"record_calls","description":"\n\u003cp\u003eRecord Calls\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls_require_authorization","full_name":"record_calls_require_authorization","description":"\n\u003cp\u003eRequire the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_id","full_name":"vertical_id","description":"\n\u003cp\u003eThe Vertical assigned to this offer, used for reporting and Vertical-scoped enrichment.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"callback_behaviour","full_name":"callback_behaviour","description":"\n\u003cp\u003eHow a caller who calls back the same offer is routed. One of \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003eforce_previous_buyer\u003c/code\u003e, or \u003ccode\u003eforce_new_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enormal\u003c/th\u003e\u003ctd\u003eNormal\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eforce_previous_buyer\u003c/th\u003e\u003ctd\u003eForce Previous Buyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eforce_new_buyer\u003c/th\u003e\u003ctd\u003eForce New Buyer\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_timeframe","full_name":"callback_reconnect_timeframe","description":"\n\u003cp\u003eThe number of seconds after a call ends during which a callback is still treated as a repeat call for routing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_buyer_ids","full_name":"callback_reconnect_buyer_ids","description":"\n\u003cp\u003eThe buyer IDs eligible to receive a reconnected callback. If blank, no buyers are reconnected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_behaviour","full_name":"callback_reconnect_behaviour","description":"\n\u003cp\u003eThe action taken once the reconnect timeframe has passed, for example \u003ccode\u003eforce_new_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_anonymous_ignore_duplicate_timeframe","full_name":"callback_anonymous_ignore_duplicate_timeframe","description":"\n\u003cp\u003eWhen true, calls from anonymous caller IDs are treated as unique calls instead of being matched to a previous call for the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_without_dupe","full_name":"callback_reconnect_without_dupe","description":"\n\u003cp\u003eWhen true, a call is not sent to a buyer who already converted a call from the same caller within the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_without_repeat","full_name":"callback_reconnect_without_repeat","description":"\n\u003cp\u003eWhen true, a call is not sent to a buyer who already answered a call from the same caller within the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_contact_field_validations","full_name":"enforce_contact_field_validations","description":"\n\u003cp\u003eWhen true, leads submitted to this offer must pass the offer’s contact field validations before they are accepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eWhen true, a lead submitted to this offer must include a \u003ccode\u003etraffic_source_id\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_traffic_source_reject_duplicates","full_name":"lead_traffic_source_reject_duplicates","description":"\n\u003cp\u003eWhen true, a lead is rejected if it duplicates an existing lead from the same traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_lead_contact_field_keys","full_name":"enforce_lead_contact_field_keys","description":"\n\u003cp\u003eWhen true, only the contact field keys configured on this offer are accepted on lead submission.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minimum_caller_number_length","full_name":"minimum_caller_number_length","description":"\n\u003cp\u003eThe minimum number of digits accepted in an inbound caller’s phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_caller_number_length","full_name":"maximum_caller_number_length","description":"\n\u003cp\u003eThe maximum number of digits accepted in an inbound caller’s phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n\u003cp\u003eThe Map Contact Field Groups applied to leads submitted to this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Contact Field Mapping Group}[/api/docs/1.0/map_contact_field_groups/index.html]. Refer to: {/api/docs/1.0/map_contact_field_groups}[/api/docs/1.0/map_contact_field_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_expire_in_months","full_name":"leads_expire_in_months","description":"\n\u003cp\u003eThe number of months a lead remains active before it is automatically archived and removed from delivery.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003eWhen true, this offer’s public posting instructions page is reachable at its posting instructions link.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eWhen true, this offer is listed on the public posting instructions index page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe title shown on this offer’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe HTML description shown on this offer’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Webhook 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\u003cp\u003eFilter for urls that are assigned to this webhook.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nremote_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nremote_method\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npost_body\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npost_headers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_parser_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_params_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_read_timeout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ping_parser_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_trigger_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_response_acceptance\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_value_map_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_response_success_codes\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_body_success_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_body_success_match\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_body_success_operator\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncache_success_for_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsuppression_on_failure\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsuppression_failure_threshold\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsuppression_buyer_suppression_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nretry_on_failure\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nretry_max_attempts\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nretry_delay_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the record to this Outgoing Webhook.\u003c/p\u003e\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":[],"deprecated":false},{"name":"remote_url","full_name":"remote_url","description":"\n\u003cp\u003eRemote URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_method","full_name":"remote_method","description":"\n\u003cp\u003eRemote Method\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003epost\u003c/code\u003e, \u003ccode\u003epost_body\u003c/code\u003e, \u003ccode\u003epost_api_v1\u003c/code\u003e, \u003ccode\u003eput\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003epatch\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_body","full_name":"post_body","description":"\n\u003cp\u003ePOST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: \u003ccode\u003e{\u0026quot;revenue\u0026quot;:10, \u0026quot;caller_id\u0026quot;: \u0026quot;1231231234\u0026quot;}\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_headers","full_name":"post_headers","description":"\n\u003cp\u003ePOST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: \u003ccode\u003eContent-Type: application/json\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA friendly name for this webhook URL, shown when managing the webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n\u003cp\u003eThe number of seconds to wait for the remote server’s response before treating the request as failed. Must be between 3 and 29.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extract_webhook_params","full_name":"extract_webhook_params","description":"\n\u003cp\u003eWhen true, on save Trackdrive removes query string parameters from the Remote URL and creates a matching Webhook Param for each one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ping_parser_ids","full_name":"buyer_ping_parser_ids","description":"\n\u003cp\u003eThe Ping Parsers applied to this URL’s response, used when its webhook fires before dialing a buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Ping Parser}[/api/docs/1.0/buyer_ping_parsers/index.html]. Refer to: {/api/docs/1.0/buyer_ping_parsers}[/api/docs/1.0/buyer_ping_parsers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead and call data to custom values by assigning these Token Value Map Groups to this URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"filter_token_value_ids","full_name":"filter_token_value_ids","description":"\n\u003cp\u003eThe Tokens used with record_token_filter_list to decide whether this URL’s webhook fires for a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n\u003cp\u003eA comma-separated list of HTTP status codes treated as a successful response, for example \u003ccode\u003e200,201\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_body_success_path","full_name":"webhook_body_success_path","description":"\n\u003cp\u003eThe path within the response body checked to confirm the request succeeded, for example \u003ccode\u003eresult.status\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_body_success_match","full_name":"webhook_body_success_match","description":"\n\u003cp\u003eThe value the response body’s \u003ccode\u003ewebhook_body_success_path\u003c/code\u003e must match for the request to be treated as successful.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_success_for_seconds","full_name":"cache_success_for_seconds","description":"\n\u003cp\u003eThe number of seconds a successful response is cached and reused for a repeat request instead of contacting the remote server again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_on_failure","full_name":"suppression_on_failure","description":"\n\u003cp\u003eWhen true, a caller is added to a suppression list after enough consecutive failures from this URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_failure_threshold","full_name":"suppression_failure_threshold","description":"\n\u003cp\u003eThe number of consecutive failures from this URL before the caller is added to the suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_buyer_suppression_id","full_name":"suppression_buyer_suppression_id","description":"\n\u003cp\u003eThe suppression list callers are added to once \u003ccode\u003esuppression_failure_threshold\u003c/code\u003e consecutive failures occur.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"retry_on_failure","full_name":"retry_on_failure","description":"\n\u003cp\u003eWhen true, a failed request to this URL is retried.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retry_max_attempts","full_name":"retry_max_attempts","description":"\n\u003cp\u003eThe maximum number of times a failed request to this URL is retried. Must be between 0 and 10.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retry_delay_seconds","full_name":"retry_delay_seconds","description":"\n\u003cp\u003eThe number of seconds to wait before retrying a failed request to this URL. Must be between 30 and 3600.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Outgoing Webhook.\u003c/p\u003e\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":[],"deprecated":false},{"name":"remote_url","full_name":"remote_url","description":"\n\u003cp\u003eRemote URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_method","full_name":"remote_method","description":"\n\u003cp\u003eRemote Method\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003epost\u003c/code\u003e, \u003ccode\u003epost_body\u003c/code\u003e, \u003ccode\u003epost_api_v1\u003c/code\u003e, \u003ccode\u003eput\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003epatch\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_body","full_name":"post_body","description":"\n\u003cp\u003ePOST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: \u003ccode\u003e{\u0026quot;revenue\u0026quot;:10, \u0026quot;caller_id\u0026quot;: \u0026quot;1231231234\u0026quot;}\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_headers","full_name":"post_headers","description":"\n\u003cp\u003ePOST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: \u003ccode\u003eContent-Type: application/json\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA friendly name for this webhook URL, shown when managing the webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n\u003cp\u003eThe number of seconds to wait for the remote server’s response before treating the request as failed. Must be between 3 and 29.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extract_webhook_params","full_name":"extract_webhook_params","description":"\n\u003cp\u003eWhen true, on save Trackdrive removes query string parameters from the Remote URL and creates a matching Webhook Param for each one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ping_parser_ids","full_name":"buyer_ping_parser_ids","description":"\n\u003cp\u003eThe Ping Parsers applied to this URL’s response, used when its webhook fires before dialing a buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Ping Parser}[/api/docs/1.0/buyer_ping_parsers/index.html]. Refer to: {/api/docs/1.0/buyer_ping_parsers}[/api/docs/1.0/buyer_ping_parsers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead and call data to custom values by assigning these Token Value Map Groups to this URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"filter_token_value_ids","full_name":"filter_token_value_ids","description":"\n\u003cp\u003eThe Tokens used with record_token_filter_list to decide whether this URL’s webhook fires for a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n\u003cp\u003eA comma-separated list of HTTP status codes treated as a successful response, for example \u003ccode\u003e200,201\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_body_success_path","full_name":"webhook_body_success_path","description":"\n\u003cp\u003eThe path within the response body checked to confirm the request succeeded, for example \u003ccode\u003eresult.status\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_body_success_match","full_name":"webhook_body_success_match","description":"\n\u003cp\u003eThe value the response body’s \u003ccode\u003ewebhook_body_success_path\u003c/code\u003e must match for the request to be treated as successful.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_success_for_seconds","full_name":"cache_success_for_seconds","description":"\n\u003cp\u003eThe number of seconds a successful response is cached and reused for a repeat request instead of contacting the remote server again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_on_failure","full_name":"suppression_on_failure","description":"\n\u003cp\u003eWhen true, a caller is added to a suppression list after enough consecutive failures from this URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_failure_threshold","full_name":"suppression_failure_threshold","description":"\n\u003cp\u003eThe number of consecutive failures from this URL before the caller is added to the suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_buyer_suppression_id","full_name":"suppression_buyer_suppression_id","description":"\n\u003cp\u003eThe suppression list callers are added to once \u003ccode\u003esuppression_failure_threshold\u003c/code\u003e consecutive failures occur.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"retry_on_failure","full_name":"retry_on_failure","description":"\n\u003cp\u003eWhen true, a failed request to this URL is retried.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retry_max_attempts","full_name":"retry_max_attempts","description":"\n\u003cp\u003eThe maximum number of times a failed request to this URL is retried. Must be between 0 and 10.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retry_delay_seconds","full_name":"retry_delay_seconds","description":"\n\u003cp\u003eThe number of seconds to wait before retrying a failed request to this URL. Must be between 30 and 3600.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Outgoing Webhook.\u003c/p\u003e\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":[],"deprecated":false},{"name":"remote_url","full_name":"remote_url","description":"\n\u003cp\u003eRemote URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remote_method","full_name":"remote_method","description":"\n\u003cp\u003eRemote Method\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003epost\u003c/code\u003e, \u003ccode\u003epost_body\u003c/code\u003e, \u003ccode\u003epost_api_v1\u003c/code\u003e, \u003ccode\u003eput\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003epatch\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_body","full_name":"post_body","description":"\n\u003cp\u003ePOST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: \u003ccode\u003e{\u0026quot;revenue\u0026quot;:10, \u0026quot;caller_id\u0026quot;: \u0026quot;1231231234\u0026quot;}\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_headers","full_name":"post_headers","description":"\n\u003cp\u003ePOST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: \u003ccode\u003eContent-Type: application/json\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eA friendly name for this webhook URL, shown when managing the webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\n\u003cp\u003eThe number of seconds to wait for the remote server’s response before treating the request as failed. Must be between 3 and 29.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extract_webhook_params","full_name":"extract_webhook_params","description":"\n\u003cp\u003eWhen true, on save Trackdrive removes query string parameters from the Remote URL and creates a matching Webhook Param for each one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ping_parser_ids","full_name":"buyer_ping_parser_ids","description":"\n\u003cp\u003eThe Ping Parsers applied to this URL’s response, used when its webhook fires before dialing a buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Ping Parser}[/api/docs/1.0/buyer_ping_parsers/index.html]. Refer to: {/api/docs/1.0/buyer_ping_parsers}[/api/docs/1.0/buyer_ping_parsers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead and call data to custom values by assigning these Token Value Map Groups to this URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"filter_token_value_ids","full_name":"filter_token_value_ids","description":"\n\u003cp\u003eThe Tokens used with record_token_filter_list to decide whether this URL’s webhook fires for a call.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\n\u003cp\u003eA comma-separated list of HTTP status codes treated as a successful response, for example \u003ccode\u003e200,201\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_body_success_path","full_name":"webhook_body_success_path","description":"\n\u003cp\u003eThe path within the response body checked to confirm the request succeeded, for example \u003ccode\u003eresult.status\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_body_success_match","full_name":"webhook_body_success_match","description":"\n\u003cp\u003eThe value the response body’s \u003ccode\u003ewebhook_body_success_path\u003c/code\u003e must match for the request to be treated as successful.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_success_for_seconds","full_name":"cache_success_for_seconds","description":"\n\u003cp\u003eThe number of seconds a successful response is cached and reused for a repeat request instead of contacting the remote server again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_on_failure","full_name":"suppression_on_failure","description":"\n\u003cp\u003eWhen true, a caller is added to a suppression list after enough consecutive failures from this URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_failure_threshold","full_name":"suppression_failure_threshold","description":"\n\u003cp\u003eThe number of consecutive failures from this URL before the caller is added to the suppression list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"suppression_buyer_suppression_id","full_name":"suppression_buyer_suppression_id","description":"\n\u003cp\u003eThe suppression list callers are added to once \u003ccode\u003esuppression_failure_threshold\u003c/code\u003e consecutive failures occur.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"retry_on_failure","full_name":"retry_on_failure","description":"\n\u003cp\u003eWhen true, a failed request to this URL is retried.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retry_max_attempts","full_name":"retry_max_attempts","description":"\n\u003cp\u003eThe maximum number of times a failed request to this URL is retried. Must be between 0 and 10.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retry_delay_seconds","full_name":"retry_delay_seconds","description":"\n\u003cp\u003eThe number of seconds to wait before retrying a failed request to this URL. Must be between 30 and 3600.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Event Triggers","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\u003cp\u003eFilter for webhooks that are assigned to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Buyer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Schedule Action.\u003c/p\u003e\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":[],"deprecated":false},{"name":"trigger_type","full_name":"trigger_type","description":"\n\u003cp\u003eWhen does this trigger fire?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eagent_enter_conference\u003c/code\u003e, \u003ccode\u003eagent_exit_conference\u003c/code\u003e, \u003ccode\u003eagent_offline\u003c/code\u003e, \u003ccode\u003eagent_online\u003c/code\u003e, \u003ccode\u003ebefore_answering_call\u003c/code\u003e, \u003ccode\u003ebefore_placing_call\u003c/code\u003e, \u003ccode\u003ebefore_schedule_action_dial\u003c/code\u003e, \u003ccode\u003ebefore_sending_text_message\u003c/code\u003e, \u003ccode\u003eboth_converted\u003c/code\u003e, \u003ccode\u003ebuyer_answered\u003c/code\u003e, \u003ccode\u003ebuyer_answered_with_contact_fields\u003c/code\u003e, \u003ccode\u003ebuyer_before_dial\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003ebuyer_dialled\u003c/code\u003e, \u003ccode\u003ebuyer_did_not_convert\u003c/code\u003e, \u003ccode\u003ebuyer_enter_conference\u003c/code\u003e, \u003ccode\u003ebuyer_exit_conference\u003c/code\u003e, \u003ccode\u003ecall_changed\u003c/code\u003e, \u003ccode\u003ecall_disposition_changed\u003c/code\u003e, \u003ccode\u003ecall_recording_updated\u003c/code\u003e, \u003ccode\u003ecall_recording_updated_call_ended\u003c/code\u003e, \u003ccode\u003econsumer_enter_conference\u003c/code\u003e, \u003ccode\u003econsumer_exit_conference\u003c/code\u003e, \u003ccode\u003econtact_fields_changed\u003c/code\u003e, \u003ccode\u003edid_not_convert\u003c/code\u003e, \u003ccode\u003eeither_converted\u003c/code\u003e, \u003ccode\u003eevery_call\u003c/code\u003e, \u003ccode\u003elead_changed\u003c/code\u003e, \u003ccode\u003elead_opted_out\u003c/code\u003e, \u003ccode\u003enew_call_started\u003c/code\u003e, \u003ccode\u003enew_lead_created\u003c/code\u003e, \u003ccode\u003eoffer_converted\u003c/code\u003e, \u003ccode\u003eoffer_did_not_convert\u003c/code\u003e, \u003ccode\u003eonly_buyer_converted\u003c/code\u003e, \u003ccode\u003eonly_offer_converted\u003c/code\u003e, \u003ccode\u003etimer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrigger_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrigger_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_action_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_url_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_value_map_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nglobal_company_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrigger_call_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncache_success_for_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_body_success_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_body_success_match\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_body_success_operator\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_path_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconnected_duration_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_path_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_path_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_path_revenue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_response_success_codes\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_path_buyer_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_path_external_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_answered_with_contact_field_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_contains_many_buyers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_path_buyers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_copy_on_company_create\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_answer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_action_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_value_map_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_manual_fire_ids\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the webhook to your company to have it fire on all calls.\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Buyer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_group_id","full_name":"buyer_group_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Buyer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_router_id","full_name":"call_router_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Call Flow.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n\u003cp\u003eAssign the record to this Schedule Action.\u003c/p\u003e\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":[],"deprecated":false},{"name":"trigger_type","full_name":"trigger_type","description":"\n\u003cp\u003eWhen does this trigger fire?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eagent_enter_conference\u003c/code\u003e, \u003ccode\u003eagent_exit_conference\u003c/code\u003e, \u003ccode\u003eagent_offline\u003c/code\u003e, \u003ccode\u003eagent_online\u003c/code\u003e, \u003ccode\u003ebefore_answering_call\u003c/code\u003e, \u003ccode\u003ebefore_placing_call\u003c/code\u003e, \u003ccode\u003ebefore_schedule_action_dial\u003c/code\u003e, \u003ccode\u003ebefore_sending_text_message\u003c/code\u003e, \u003ccode\u003eboth_converted\u003c/code\u003e, \u003ccode\u003ebuyer_answered\u003c/code\u003e, \u003ccode\u003ebuyer_answered_with_contact_fields\u003c/code\u003e, \u003ccode\u003ebuyer_before_dial\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003ebuyer_dialled\u003c/code\u003e, \u003ccode\u003ebuyer_did_not_convert\u003c/code\u003e, \u003ccode\u003ebuyer_enter_conference\u003c/code\u003e, \u003ccode\u003ebuyer_exit_conference\u003c/code\u003e, \u003ccode\u003ecall_changed\u003c/code\u003e, \u003ccode\u003ecall_disposition_changed\u003c/code\u003e, \u003ccode\u003ecall_recording_updated\u003c/code\u003e, \u003ccode\u003ecall_recording_updated_call_ended\u003c/code\u003e, \u003ccode\u003econsumer_enter_conference\u003c/code\u003e, \u003ccode\u003econsumer_exit_conference\u003c/code\u003e, \u003ccode\u003econtact_fields_changed\u003c/code\u003e, \u003ccode\u003edid_not_convert\u003c/code\u003e, \u003ccode\u003eeither_converted\u003c/code\u003e, \u003ccode\u003eevery_call\u003c/code\u003e, \u003ccode\u003elead_changed\u003c/code\u003e, \u003ccode\u003elead_opted_out\u003c/code\u003e, \u003ccode\u003enew_call_started\u003c/code\u003e, \u003ccode\u003enew_lead_created\u003c/code\u003e, \u003ccode\u003eoffer_converted\u003c/code\u003e, \u003ccode\u003eoffer_did_not_convert\u003c/code\u003e, \u003ccode\u003eonly_buyer_converted\u003c/code\u003e, \u003ccode\u003eonly_offer_converted\u003c/code\u003e, \u003ccode\u003etimer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_duration","full_name":"trigger_duration","description":"\n\u003cp\u003eHow many seconds must pass for the trigger to fire?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_call_status","full_name":"trigger_call_status","description":"\n\u003cp\u003eRestrict which call statuses fire the webhook. Leave blank to fire regardless of status. \u003ccode\u003elive\u003c/code\u003e only fires while the call is in progress, \u003ccode\u003eended\u003c/code\u003e only fires after the call has completed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connected_duration_seconds","full_name":"connected_duration_seconds","description":"\n\u003cp\u003eWait to fire the webhook until the buyer has been connected with the caller for this many seconds. If the call ends before that much time has passed, the webhook does not fire. Leave blank to fire as soon as the buyer connects.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_success_for_seconds","full_name":"cache_success_for_seconds","description":"\n\u003cp\u003eHow long, in seconds, to cache a successful response from the webhook before checking it again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eThe order global webhooks fire in, from lowest to highest; webhooks assigned to a Buyer, Offer, etc are always tier 0. Set this below 0 to fire before other webhooks in your account. Only applies when \u003ccode\u003eglobal_company_id\u003c/code\u003e is set.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_answered_with_contact_field_ids","full_name":"buyer_answered_with_contact_field_ids","description":"\n\u003cp\u003eFire only after the buyer has answered and all of these Contact Fields have values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead data to custom values by assigning these Token Value Map Groups to the webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the webhook to your company to have it fire on all calls.\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Buyer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_group_id","full_name":"buyer_group_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Buyer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_router_id","full_name":"call_router_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Call Flow.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n\u003cp\u003eAssign the record to this Schedule Action.\u003c/p\u003e\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":[],"deprecated":false},{"name":"trigger_type","full_name":"trigger_type","description":"\n\u003cp\u003eWhen does this trigger fire?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eagent_enter_conference\u003c/code\u003e, \u003ccode\u003eagent_exit_conference\u003c/code\u003e, \u003ccode\u003eagent_offline\u003c/code\u003e, \u003ccode\u003eagent_online\u003c/code\u003e, \u003ccode\u003ebefore_answering_call\u003c/code\u003e, \u003ccode\u003ebefore_placing_call\u003c/code\u003e, \u003ccode\u003ebefore_schedule_action_dial\u003c/code\u003e, \u003ccode\u003ebefore_sending_text_message\u003c/code\u003e, \u003ccode\u003eboth_converted\u003c/code\u003e, \u003ccode\u003ebuyer_answered\u003c/code\u003e, \u003ccode\u003ebuyer_answered_with_contact_fields\u003c/code\u003e, \u003ccode\u003ebuyer_before_dial\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003ebuyer_dialled\u003c/code\u003e, \u003ccode\u003ebuyer_did_not_convert\u003c/code\u003e, \u003ccode\u003ebuyer_enter_conference\u003c/code\u003e, \u003ccode\u003ebuyer_exit_conference\u003c/code\u003e, \u003ccode\u003ecall_changed\u003c/code\u003e, \u003ccode\u003ecall_disposition_changed\u003c/code\u003e, \u003ccode\u003ecall_recording_updated\u003c/code\u003e, \u003ccode\u003ecall_recording_updated_call_ended\u003c/code\u003e, \u003ccode\u003econsumer_enter_conference\u003c/code\u003e, \u003ccode\u003econsumer_exit_conference\u003c/code\u003e, \u003ccode\u003econtact_fields_changed\u003c/code\u003e, \u003ccode\u003edid_not_convert\u003c/code\u003e, \u003ccode\u003eeither_converted\u003c/code\u003e, \u003ccode\u003eevery_call\u003c/code\u003e, \u003ccode\u003elead_changed\u003c/code\u003e, \u003ccode\u003elead_opted_out\u003c/code\u003e, \u003ccode\u003enew_call_started\u003c/code\u003e, \u003ccode\u003enew_lead_created\u003c/code\u003e, \u003ccode\u003eoffer_converted\u003c/code\u003e, \u003ccode\u003eoffer_did_not_convert\u003c/code\u003e, \u003ccode\u003eonly_buyer_converted\u003c/code\u003e, \u003ccode\u003eonly_offer_converted\u003c/code\u003e, \u003ccode\u003etimer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_duration","full_name":"trigger_duration","description":"\n\u003cp\u003eHow many seconds must pass for the trigger to fire?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_call_status","full_name":"trigger_call_status","description":"\n\u003cp\u003eRestrict which call statuses fire the webhook. Leave blank to fire regardless of status. \u003ccode\u003elive\u003c/code\u003e only fires while the call is in progress, \u003ccode\u003eended\u003c/code\u003e only fires after the call has completed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connected_duration_seconds","full_name":"connected_duration_seconds","description":"\n\u003cp\u003eWait to fire the webhook until the buyer has been connected with the caller for this many seconds. If the call ends before that much time has passed, the webhook does not fire. Leave blank to fire as soon as the buyer connects.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_success_for_seconds","full_name":"cache_success_for_seconds","description":"\n\u003cp\u003eHow long, in seconds, to cache a successful response from the webhook before checking it again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eThe order global webhooks fire in, from lowest to highest; webhooks assigned to a Buyer, Offer, etc are always tier 0. Set this below 0 to fire before other webhooks in your account. Only applies when \u003ccode\u003eglobal_company_id\u003c/code\u003e is set.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_answered_with_contact_field_ids","full_name":"buyer_answered_with_contact_field_ids","description":"\n\u003cp\u003eFire only after the buyer has answered and all of these Contact Fields have values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead data to custom values by assigning these Token Value Map Groups to the webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe human friendly name of this webhook.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_message_flow_id","full_name":"text_message_flow_id","description":"\n\u003cp\u003eAssign the webhook to this SMS Flow to have it fire on that flow’s messages.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {SMS AI Flow}[/api/docs/1.0/text_message_flows/index.html]. Refer to: {/api/docs/1.0/text_message_flows}[/api/docs/1.0/text_message_flows/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_answer_id","full_name":"call_router_answer_id","description":"\n\u003cp\u003eAssign the webhook to this Call Flow Answer to have it fire when that answer is used.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Call Router Answer}[/api/docs/1.0/call_router_answers/index.html]. Refer to: {/api/docs/1.0/call_router_answers}[/api/docs/1.0/call_router_answers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAssign the webhook to your company to have it fire on all calls.\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Buyer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_group_id","full_name":"buyer_group_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Buyer Group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_router_id","full_name":"call_router_id","description":"\n\u003cp\u003eFilter for webhooks that are assigned to this Call Flow.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\n\u003cp\u003eAssign the record to this Schedule Action.\u003c/p\u003e\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":[],"deprecated":false},{"name":"trigger_type","full_name":"trigger_type","description":"\n\u003cp\u003eWhen does this trigger fire?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eagent_enter_conference\u003c/code\u003e, \u003ccode\u003eagent_exit_conference\u003c/code\u003e, \u003ccode\u003eagent_offline\u003c/code\u003e, \u003ccode\u003eagent_online\u003c/code\u003e, \u003ccode\u003ebefore_answering_call\u003c/code\u003e, \u003ccode\u003ebefore_placing_call\u003c/code\u003e, \u003ccode\u003ebefore_schedule_action_dial\u003c/code\u003e, \u003ccode\u003ebefore_sending_text_message\u003c/code\u003e, \u003ccode\u003eboth_converted\u003c/code\u003e, \u003ccode\u003ebuyer_answered\u003c/code\u003e, \u003ccode\u003ebuyer_answered_with_contact_fields\u003c/code\u003e, \u003ccode\u003ebuyer_before_dial\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003ebuyer_dialled\u003c/code\u003e, \u003ccode\u003ebuyer_did_not_convert\u003c/code\u003e, \u003ccode\u003ebuyer_enter_conference\u003c/code\u003e, \u003ccode\u003ebuyer_exit_conference\u003c/code\u003e, \u003ccode\u003ecall_changed\u003c/code\u003e, \u003ccode\u003ecall_disposition_changed\u003c/code\u003e, \u003ccode\u003ecall_recording_updated\u003c/code\u003e, \u003ccode\u003ecall_recording_updated_call_ended\u003c/code\u003e, \u003ccode\u003econsumer_enter_conference\u003c/code\u003e, \u003ccode\u003econsumer_exit_conference\u003c/code\u003e, \u003ccode\u003econtact_fields_changed\u003c/code\u003e, \u003ccode\u003edid_not_convert\u003c/code\u003e, \u003ccode\u003eeither_converted\u003c/code\u003e, \u003ccode\u003eevery_call\u003c/code\u003e, \u003ccode\u003elead_changed\u003c/code\u003e, \u003ccode\u003elead_opted_out\u003c/code\u003e, \u003ccode\u003enew_call_started\u003c/code\u003e, \u003ccode\u003enew_lead_created\u003c/code\u003e, \u003ccode\u003eoffer_converted\u003c/code\u003e, \u003ccode\u003eoffer_did_not_convert\u003c/code\u003e, \u003ccode\u003eonly_buyer_converted\u003c/code\u003e, \u003ccode\u003eonly_offer_converted\u003c/code\u003e, \u003ccode\u003etimer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_duration","full_name":"trigger_duration","description":"\n\u003cp\u003eHow many seconds must pass for the trigger to fire?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_call_status","full_name":"trigger_call_status","description":"\n\u003cp\u003eRestrict which call statuses fire the webhook. Leave blank to fire regardless of status. \u003ccode\u003elive\u003c/code\u003e only fires while the call is in progress, \u003ccode\u003eended\u003c/code\u003e only fires after the call has completed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"connected_duration_seconds","full_name":"connected_duration_seconds","description":"\n\u003cp\u003eWait to fire the webhook until the buyer has been connected with the caller for this many seconds. If the call ends before that much time has passed, the webhook does not fire. Leave blank to fire as soon as the buyer connects.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cache_success_for_seconds","full_name":"cache_success_for_seconds","description":"\n\u003cp\u003eHow long, in seconds, to cache a successful response from the webhook before checking it again.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\n\u003cp\u003eThe order global webhooks fire in, from lowest to highest; webhooks assigned to a Buyer, Offer, etc are always tier 0. Set this below 0 to fire before other webhooks in your account. Only applies when \u003ccode\u003eglobal_company_id\u003c/code\u003e is set.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_answered_with_contact_field_ids","full_name":"buyer_answered_with_contact_field_ids","description":"\n\u003cp\u003eFire only after the buyer has answered and all of these Contact Fields have values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead data to custom values by assigning these Token Value Map Groups to the webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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},"phone_numbers":{"doc_url":"/api/docs/1.0/phone_numbers","id":"phone_numbers","api_url":"/api","name":"Phone Numbers","short_description":"The tracking 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":"List your phone numbers","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enumber\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enumber_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number","full_name":"number","description":"\n\u003cp\u003eThe phone number.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eRefer to the provider api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eRefer to the Number Pool api for details\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_call_at_to","full_name":"last_call_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_call_at_from","full_name":"last_call_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_configuration_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_auth_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_call_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_values\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncountry\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\narea_code_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noptimizer_displayed_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noptimizer_tokens_changed_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nplain_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nextension\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nchecksum\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhuman_number\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/phone_numbers/create","name":"create","apis":[{"api_url":"/api/v1/phone_numbers","http_method":"POST","short_description":"Purchase a phone number","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003ePurchase a new phone number using one of your existing provider configurations.\u003c/p\u003e\n","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enumber\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enumber_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"forward_type","full_name":"forward_type","description":"\n\u003cp\u003eForward Type - Should the number forward to an Offer or a Buyer\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer_id\u003c/th\u003e\u003ctd\u003eForward to Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_id\u003c/th\u003e\u003ctd\u003eForward to Buyer\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eThe buyer calls forward to when \u003ccode\u003eforward_type\u003c/code\u003e is \u003ccode\u003ebuyer_id\u003c/code\u003e. Required with that forward type. If the buyer does not answer, the exception handling of your account’s direct forward offer applies.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eRefer to the provider api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"toll_free","full_name":"toll_free","description":"\n\u003cp\u003ePurchase a toll-free or local number? true for toll-free, false for local number.\u003c/p\u003e\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":[],"deprecated":false},{"name":"country","full_name":"country","description":"\n\u003cp\u003eThe country where the number will be purchased.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAU\u003c/code\u003e, \u003ccode\u003eCA\u003c/code\u003e, \u003ccode\u003eGB\u003c/code\u003e, \u003ccode\u003eUS\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"requested_number","full_name":"requested_number","description":"\n\u003cp\u003eThe phone number you wish to purchase from /api/v1/phone_numbers/search\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eRefer to the Number Pool api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_override_lead_traffic_source","full_name":"traffic_source_override_lead_traffic_source","description":"\n\u003cp\u003eForce Calls to Credit This Traffic Source and Extra Tokens, even if Lead Traffic Source or Data is Different\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enumber\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enumber_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThis can be either the internal trackdrive id or the full phone number beginning with ‘+’\u003cbr\u003e\u003cbr\u003e For example:\u003cbr\u003e\u003cbr\u003e To find a number using trackdrive’s internal id pass \u003ccode\u003eid=185923\u003c/code\u003e\u003cbr\u003e\u003cbr\u003e To find a number using the phone number pass \u003ccode\u003eid=+18005002562\u0026quot;\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 source or pool","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enumber\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enumber_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThis can be either the internal trackdrive id or the full phone number beginning with ‘+’\u003cbr\u003e\u003cbr\u003e For example:\u003cbr\u003e\u003cbr\u003e To find a number using trackdrive’s internal id pass \u003ccode\u003eid=185923\u003c/code\u003e\u003cbr\u003e\u003cbr\u003e To find a number using the phone number pass \u003ccode\u003eid=+18005002562\u0026quot;\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA note that identifies the number in your account.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"forward_type","full_name":"forward_type","description":"\n\u003cp\u003eForward Type - Should the number forward to an Offer or a Buyer\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer_id\u003c/th\u003e\u003ctd\u003eForward to Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebuyer_id\u003c/th\u003e\u003ctd\u003eForward to Buyer\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eThe buyer calls forward to when \u003ccode\u003eforward_type\u003c/code\u003e is \u003ccode\u003ebuyer_id\u003c/code\u003e. Required with that forward type. If the buyer does not answer, the exception handling of your account’s direct forward offer applies.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eRefer to the Number Pool api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_override_lead_traffic_source","full_name":"traffic_source_override_lead_traffic_source","description":"\n\u003cp\u003eForce Calls to Credit This Traffic Source and Extra Tokens, even if Lead Traffic Source or Data is Different\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_key_press_flows","full_name":"use_with_key_press_flows","description":"\n\u003cp\u003eApply a key press flow group to calls on this number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group applied when \u003ccode\u003euse_with_key_press_flows\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_match_sort_order","full_name":"lead_match_sort_order","description":"\n\u003cp\u003eWhich leads to search first when matching an inbound caller to an existing lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule_leads_first\u003c/th\u003e\u003ctd\u003e[Default] Search for a matching schedule lead before considering offer leads.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_leads_first\u003c/th\u003e\u003ctd\u003eSearch for a matching offer lead before considering schedule leads.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delete_prevention","full_name":"delete_prevention","description":"\n\u003cp\u003eWhen true, the number cannot be deleted until deletion prevention is turned off.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enumber\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enumber_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eThis can be either the internal trackdrive id or the full phone number beginning with ‘+’\u003cbr\u003e\u003cbr\u003e For example:\u003cbr\u003e\u003cbr\u003e To find a number using trackdrive’s internal id pass \u003ccode\u003eid=185923\u003c/code\u003e\u003cbr\u003e\u003cbr\u003e To find a number using the phone number pass \u003ccode\u003eid=+18005002562\u0026quot;\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/phone_numbers/search","name":"search","apis":[{"api_url":"/api/v1/phone_numbers/search","http_method":"GET","short_description":"Search available phone numbers for purchase","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of available phone numbers for sale. Can be used with POST /api/v1/phone_numbers?requested_number=[phone_number] to purchase a number.\u003c/p\u003e\n","errors":[],"params":[{"name":"country","full_name":"country","description":"\n\u003cp\u003eTwo-letter country code (default: US)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"toll_free","full_name":"toll_free","description":"\n\u003cp\u003eWhether to search toll-free numbers\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prefix","full_name":"prefix","description":"\n\u003cp\u003eRestrict by area code (NPA). Example: 415, 209, 719\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"query","full_name":"query","description":"\n\u003cp\u003eFull or partial phone number to match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":"Telephone Accounts","short_description":"The Phone Providers in your Trackdrive account. One of: Trackdrive, Twilio, and Plivo.","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 Phone Providers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eprovider_configuration\u003c/th\u003e\u003ctd\u003eProvider Configuration\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eprovider_configuration_grid\u003c/th\u003e\u003ctd\u003eProvider Configuration Grid\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_auto_recharge\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_user_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_app\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_default\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003etype\u003c/code\u003e, \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003edeleted_at\u003c/code\u003e, \u003ccode\u003emax_requests_per_interval\u003c/code\u003e, \u003ccode\u003emax_requests_per_caller\u003c/code\u003e, \u003ccode\u003emax_requests_per_number\u003c/code\u003e, \u003ccode\u003emax_requests_per_provider\u003c/code\u003e, \u003ccode\u003erequests_interval_for_caller\u003c/code\u003e, \u003ccode\u003erequests_interval_for_number\u003c/code\u003e, \u003ccode\u003erequests_interval_for_provider\u003c/code\u003e, \u003ccode\u003emax_requests_per_second\u003c/code\u003e, \u003ccode\u003eblock_rate_limited_caller\u003c/code\u003e, \u003ccode\u003eis_default\u003c/code\u003e, \u003ccode\u003emax_requests_per_npa_nxx\u003c/code\u003e, \u003ccode\u003erequests_interval_for_npa_nxx\u003c/code\u003e, \u003ccode\u003enumbers_count\u003c/code\u003e, \u003ccode\u003elast_call_at\u003c/code\u003e, \u003ccode\u003ecalls_count\u003c/code\u003e, \u003ccode\u003erecent_calls_count\u003c/code\u003e, \u003ccode\u003edisconnected_at\u003c/code\u003e, \u003ccode\u003econnected_status\u003c/code\u003e, \u003ccode\u003econnected_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Find Specific Phone Provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eprovider_configuration\u003c/th\u003e\u003ctd\u003eProvider Configuration\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eprovider_configuration_grid\u003c/th\u003e\u003ctd\u003eProvider Configuration Grid\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Specific Phone Provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eprovider_configuration\u003c/th\u003e\u003ctd\u003eProvider Configuration\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eprovider_configuration_grid\u003c/th\u003e\u003ctd\u003eProvider Configuration Grid\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProvide a name that will appear throughout Trackdrive.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_default","full_name":"is_default","description":"\n\u003cp\u003eIs this provider the default for new number purchases.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"block_rate_limited_caller","full_name":"block_rate_limited_caller","description":"\n\u003cp\u003eWhen a caller exceeds its rate limit, permanently block that caller’s number instead of only rejecting the excess calls.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_requests_per_caller","full_name":"max_requests_per_caller","description":"\n\u003cp\u003eMaximum inbound calls allowed from a single caller within requests_interval_for_caller seconds before it is treated as abusive traffic.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"requests_interval_for_caller","full_name":"requests_interval_for_caller","description":"\n\u003cp\u003eRolling time window, in seconds, used to measure max_requests_per_caller.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_requests_per_number","full_name":"max_requests_per_number","description":"\n\u003cp\u003eMaximum inbound calls allowed to a single tracking number within requests_interval_for_number seconds before it is treated as abusive traffic.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"requests_interval_for_number","full_name":"requests_interval_for_number","description":"\n\u003cp\u003eRolling time window, in seconds, used to measure max_requests_per_number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_requests_per_provider","full_name":"max_requests_per_provider","description":"\n\u003cp\u003eMaximum inbound calls allowed across this provider account within requests_interval_for_provider seconds before it is treated as abusive traffic.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"requests_interval_for_provider","full_name":"requests_interval_for_provider","description":"\n\u003cp\u003eRolling time window, in seconds, used to measure max_requests_per_provider.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_requests_per_npa_nxx","full_name":"max_requests_per_npa_nxx","description":"\n\u003cp\u003eMaximum inbound calls allowed from a single area code and prefix combination within requests_interval_for_npa_nxx seconds before it is treated as abusive traffic.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"requests_interval_for_npa_nxx","full_name":"requests_interval_for_npa_nxx","description":"\n\u003cp\u003eRolling time window, in seconds, used to measure max_requests_per_npa_nxx.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Number Pools","short_description":"A pool of tracking phone numbers assigned to a traffic source; a different number is swapped in per website visitor to attribute their calls.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoll_free\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncountry\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncampaign_registry_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_stockpile\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_override_lead_traffic_source\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nper_visitor\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntracking_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nextensions_length\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nextensions_minimum\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nextensions_maximum\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_configuration_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nauto_rent_numbers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_active\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eOffer\u003c/p\u003e\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":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eRefer to the provider api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eTraffic Source\u003c/p\u003e\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":[],"deprecated":false},{"name":"numbers_count","full_name":"numbers_count","description":"\n\u003cp\u003eNumbers Count\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"toll_free","full_name":"toll_free","description":"\n\u003cp\u003eToll Free\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"country","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_limit","full_name":"number_limit","description":"\n\u003cp\u003eNumber Limit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this Number Pool, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eUse this Number Pool for Dynamic Number Insertion. Only one Number Pool can be active per Offer and Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_visitor","full_name":"per_visitor","description":"\n\u003cp\u003eAssign each website visitor their own number from the pool, so calls can be attributed to that visitor.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_hold_time","full_name":"token_hold_time","description":"\n\u003cp\u003eHow many seconds a number stays assigned to a caller’s token before it can be reassigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_stockpile","full_name":"number_stockpile","description":"\n\u003cp\u003eHow many numbers to keep in reserve, ready and unassigned, within this pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_rent_numbers","full_name":"auto_rent_numbers","description":"\n\u003cp\u003eAutomatically purchase numbers up to the Number Limit as they are needed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"area_code_id","full_name":"area_code_id","description":"\n\u003cp\u003eThe preferred area code to purchase numbers from when Auto Rent Numbers is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"hide_embedded_access","full_name":"hide_embedded_access","description":"\n\u003cp\u003ePrevent this Number Pool from being used for embedded Dynamic Number Insertion access on more than one Traffic Source per Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_analytics","full_name":"google_analytics","description":"\n\u003cp\u003eTrack calls from this Number Pool with Google Analytics.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_analytics_account","full_name":"google_analytics_account","description":"\n\u003cp\u003eYour Google Analytics account id used when Google Analytics is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_ping_time","full_name":"maximum_ping_time","description":"\n\u003cp\u003eThe maximum number of seconds a browser will wait for a number to be returned before giving up.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_length","full_name":"extensions_length","description":"\n\u003cp\u003eThe number of digits used for extensions when Extensions are enabled on this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_minimum","full_name":"extensions_minimum","description":"\n\u003cp\u003eThe lowest extension number that can be assigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_maximum","full_name":"extensions_maximum","description":"\n\u003cp\u003eThe highest extension number that can be assigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_id","full_name":"campaign_registry_id","description":"\n\u003cp\u003eThe Campaign Registry ID applied to every number in this pool for SMS compliance.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_approve","full_name":"campaign_registry_approve","description":"\n\u003cp\u003eManually mark every number in this pool as Campaign Registry approved.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_unapprove","full_name":"campaign_registry_unapprove","description":"\n\u003cp\u003eManually mark every number in this pool as Campaign Registry unapproved.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fill_pool","full_name":"fill_pool","description":"\n\u003cp\u003eImmediately purchase numbers until this pool reaches its Number Limit.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_override_lead_traffic_source","full_name":"traffic_source_override_lead_traffic_source","description":"\n\u003cp\u003eForce calls placed to this Number Pool’s numbers to credit this pool’s Traffic Source, even when the lead’s Traffic Source is different.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_with_area_codes","full_name":"dial_with_area_codes","description":"\n\u003cp\u003eWhen placing outbound calls, prefer a number from the pool matching the consumer’s area code. If none is available, an area code match from area_code_maps or any toll free number in the pool is used instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_with_any_state_area_code","full_name":"dial_with_any_state_area_code","description":"\n\u003cp\u003eWhen Dial With Area Codes is enabled and no matching area code is available, allow dialing with any area code in the consumer’s state.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThe ids of the Token Values whose tokens will be additionally applied to calls handled by this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to calls handled by this Number Pool by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cid","full_name":"cid","description":"\n\u003cp\u003eAlternative to offer_id. Matches an Offer by your own external Offer identifier instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"afid","full_name":"afid","description":"\n\u003cp\u003eAlternative to traffic_source_id. Matches a Traffic Source by your own external Traffic Source identifier instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_type","full_name":"number_type","description":"\n\u003cp\u003eThe type of Number Pool, such as RingPool for phone tracking numbers or SmsNumberGroup for SMS sending numbers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eOffer\u003c/p\u003e\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":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eRefer to the provider api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eTraffic Source\u003c/p\u003e\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":[],"deprecated":false},{"name":"numbers_count","full_name":"numbers_count","description":"\n\u003cp\u003eNumbers Count\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"toll_free","full_name":"toll_free","description":"\n\u003cp\u003eToll Free\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"country","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_limit","full_name":"number_limit","description":"\n\u003cp\u003eNumber Limit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this Number Pool, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eUse this Number Pool for Dynamic Number Insertion. Only one Number Pool can be active per Offer and Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_visitor","full_name":"per_visitor","description":"\n\u003cp\u003eAssign each website visitor their own number from the pool, so calls can be attributed to that visitor.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_hold_time","full_name":"token_hold_time","description":"\n\u003cp\u003eHow many seconds a number stays assigned to a caller’s token before it can be reassigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_stockpile","full_name":"number_stockpile","description":"\n\u003cp\u003eHow many numbers to keep in reserve, ready and unassigned, within this pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_rent_numbers","full_name":"auto_rent_numbers","description":"\n\u003cp\u003eAutomatically purchase numbers up to the Number Limit as they are needed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"area_code_id","full_name":"area_code_id","description":"\n\u003cp\u003eThe preferred area code to purchase numbers from when Auto Rent Numbers is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"hide_embedded_access","full_name":"hide_embedded_access","description":"\n\u003cp\u003ePrevent this Number Pool from being used for embedded Dynamic Number Insertion access on more than one Traffic Source per Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_analytics","full_name":"google_analytics","description":"\n\u003cp\u003eTrack calls from this Number Pool with Google Analytics.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_analytics_account","full_name":"google_analytics_account","description":"\n\u003cp\u003eYour Google Analytics account id used when Google Analytics is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_ping_time","full_name":"maximum_ping_time","description":"\n\u003cp\u003eThe maximum number of seconds a browser will wait for a number to be returned before giving up.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_length","full_name":"extensions_length","description":"\n\u003cp\u003eThe number of digits used for extensions when Extensions are enabled on this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_minimum","full_name":"extensions_minimum","description":"\n\u003cp\u003eThe lowest extension number that can be assigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_maximum","full_name":"extensions_maximum","description":"\n\u003cp\u003eThe highest extension number that can be assigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_id","full_name":"campaign_registry_id","description":"\n\u003cp\u003eThe Campaign Registry ID applied to every number in this pool for SMS compliance.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_approve","full_name":"campaign_registry_approve","description":"\n\u003cp\u003eManually mark every number in this pool as Campaign Registry approved.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_unapprove","full_name":"campaign_registry_unapprove","description":"\n\u003cp\u003eManually mark every number in this pool as Campaign Registry unapproved.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fill_pool","full_name":"fill_pool","description":"\n\u003cp\u003eImmediately purchase numbers until this pool reaches its Number Limit.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_override_lead_traffic_source","full_name":"traffic_source_override_lead_traffic_source","description":"\n\u003cp\u003eForce calls placed to this Number Pool’s numbers to credit this pool’s Traffic Source, even when the lead’s Traffic Source is different.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_with_area_codes","full_name":"dial_with_area_codes","description":"\n\u003cp\u003eWhen placing outbound calls, prefer a number from the pool matching the consumer’s area code. If none is available, an area code match from area_code_maps or any toll free number in the pool is used instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_with_any_state_area_code","full_name":"dial_with_any_state_area_code","description":"\n\u003cp\u003eWhen Dial With Area Codes is enabled and no matching area code is available, allow dialing with any area code in the consumer’s state.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThe ids of the Token Values whose tokens will be additionally applied to calls handled by this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to calls handled by this Number Pool by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cid","full_name":"cid","description":"\n\u003cp\u003eAlternative to offer_id. Matches an Offer by your own external Offer identifier instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"afid","full_name":"afid","description":"\n\u003cp\u003eAlternative to traffic_source_id. Matches a Traffic Source by your own external Traffic Source identifier instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_type","full_name":"number_type","description":"\n\u003cp\u003eThe type of Number Pool, such as RingPool for phone tracking numbers or SmsNumberGroup for SMS sending numbers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eOffer\u003c/p\u003e\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":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eRefer to the provider api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eTraffic Source\u003c/p\u003e\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":[],"deprecated":false},{"name":"numbers_count","full_name":"numbers_count","description":"\n\u003cp\u003eNumbers Count\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"toll_free","full_name":"toll_free","description":"\n\u003cp\u003eToll Free\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"country","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_limit","full_name":"number_limit","description":"\n\u003cp\u003eNumber Limit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this Number Pool, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_active","full_name":"is_active","description":"\n\u003cp\u003eUse this Number Pool for Dynamic Number Insertion. Only one Number Pool can be active per Offer and Traffic Source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_visitor","full_name":"per_visitor","description":"\n\u003cp\u003eAssign each website visitor their own number from the pool, so calls can be attributed to that visitor.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_hold_time","full_name":"token_hold_time","description":"\n\u003cp\u003eHow many seconds a number stays assigned to a caller’s token before it can be reassigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_stockpile","full_name":"number_stockpile","description":"\n\u003cp\u003eHow many numbers to keep in reserve, ready and unassigned, within this pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_rent_numbers","full_name":"auto_rent_numbers","description":"\n\u003cp\u003eAutomatically purchase numbers up to the Number Limit as they are needed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"area_code_id","full_name":"area_code_id","description":"\n\u003cp\u003eThe preferred area code to purchase numbers from when Auto Rent Numbers is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"hide_embedded_access","full_name":"hide_embedded_access","description":"\n\u003cp\u003ePrevent this Number Pool from being used for embedded Dynamic Number Insertion access on more than one Traffic Source per Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_analytics","full_name":"google_analytics","description":"\n\u003cp\u003eTrack calls from this Number Pool with Google Analytics.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_analytics_account","full_name":"google_analytics_account","description":"\n\u003cp\u003eYour Google Analytics account id used when Google Analytics is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_ping_time","full_name":"maximum_ping_time","description":"\n\u003cp\u003eThe maximum number of seconds a browser will wait for a number to be returned before giving up.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_length","full_name":"extensions_length","description":"\n\u003cp\u003eThe number of digits used for extensions when Extensions are enabled on this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_minimum","full_name":"extensions_minimum","description":"\n\u003cp\u003eThe lowest extension number that can be assigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"extensions_maximum","full_name":"extensions_maximum","description":"\n\u003cp\u003eThe highest extension number that can be assigned.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_id","full_name":"campaign_registry_id","description":"\n\u003cp\u003eThe Campaign Registry ID applied to every number in this pool for SMS compliance.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_approve","full_name":"campaign_registry_approve","description":"\n\u003cp\u003eManually mark every number in this pool as Campaign Registry approved.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_registry_unapprove","full_name":"campaign_registry_unapprove","description":"\n\u003cp\u003eManually mark every number in this pool as Campaign Registry unapproved.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fill_pool","full_name":"fill_pool","description":"\n\u003cp\u003eImmediately purchase numbers until this pool reaches its Number Limit.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_override_lead_traffic_source","full_name":"traffic_source_override_lead_traffic_source","description":"\n\u003cp\u003eForce calls placed to this Number Pool’s numbers to credit this pool’s Traffic Source, even when the lead’s Traffic Source is different.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_with_area_codes","full_name":"dial_with_area_codes","description":"\n\u003cp\u003eWhen placing outbound calls, prefer a number from the pool matching the consumer’s area code. If none is available, an area code match from area_code_maps or any toll free number in the pool is used instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_with_any_state_area_code","full_name":"dial_with_any_state_area_code","description":"\n\u003cp\u003eWhen Dial With Area Codes is enabled and no matching area code is available, allow dialing with any area code in the consumer’s state.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThe ids of the Token Values whose tokens will be additionally applied to calls handled by this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to calls handled by this Number Pool by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cid","full_name":"cid","description":"\n\u003cp\u003eAlternative to offer_id. Matches an Offer by your own external Offer identifier instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"afid","full_name":"afid","description":"\n\u003cp\u003eAlternative to traffic_source_id. Matches a Traffic Source by your own external Traffic Source identifier instead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_type","full_name":"number_type","description":"\n\u003cp\u003eThe type of Number Pool, such as RingPool for phone tracking numbers or SmsNumberGroup for SMS sending numbers.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Groups","short_description":"A named, reusable bundle of call actions, such as transferring, hanging up, or sending an SMS, that run together when triggered by an agent status change or a matched transcription.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_action_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_actions_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eThe schedule this action belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_relation","full_name":"owner_relation","description":"\n\u003cp\u003eFilter for actions belonging to this action list, such as the schedule’s main actions or its End Of Schedule Actions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactions\u003c/code\u003e, \u003ccode\u003eend_of_schedule_actions\u003c/code\u003e, \u003ccode\u003ewebhook_actions\u003c/code\u003e, \u003ccode\u003ecall_disposition_actions\u003c/code\u003e, \u003ccode\u003ecall_control_actions\u003c/code\u003e, \u003ccode\u003ekey_press_flows\u003c/code\u003e, \u003ccode\u003elead_retarget_actions\u003c/code\u003e, \u003ccode\u003eschedule_actions\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eThe schedule this action belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_relation","full_name":"owner_relation","description":"\n\u003cp\u003eWhich action list this action belongs to, such as the schedule’s main actions or its End Of Schedule Actions.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactions\u003c/code\u003e, \u003ccode\u003eend_of_schedule_actions\u003c/code\u003e, \u003ccode\u003ewebhook_actions\u003c/code\u003e, \u003ccode\u003ecall_disposition_actions\u003c/code\u003e, \u003ccode\u003ecall_control_actions\u003c/code\u003e, \u003ccode\u003ekey_press_flows\u003c/code\u003e, \u003ccode\u003elead_retarget_actions\u003c/code\u003e, \u003ccode\u003eschedule_actions\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_type","full_name":"action_type","description":"\n\u003cp\u003eThe type of action to perform, such as dial, sms, wait, or webhook.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edial\u003c/code\u003e, \u003ccode\u003esms\u003c/code\u003e, \u003ccode\u003ewait\u003c/code\u003e, \u003ccode\u003ewebhook\u003c/code\u003e, \u003ccode\u003eadd_to_schedule\u003c/code\u003e, \u003ccode\u003elead_alteration\u003c/code\u003e, \u003ccode\u003ezoho_crm\u003c/code\u003e, \u003ccode\u003elead_block\u003c/code\u003e, \u003ccode\u003elead_opt_out\u003c/code\u003e, \u003ccode\u003eschedule_callback\u003c/code\u003e, \u003ccode\u003echoice\u003c/code\u003e, \u003ccode\u003erestart_schedule\u003c/code\u003e, \u003ccode\u003emailchimp\u003c/code\u003e, \u003ccode\u003esendgrid\u003c/code\u003e, \u003ccode\u003emailgun\u003c/code\u003e, \u003ccode\u003einfusionsoft\u003c/code\u003e, \u003ccode\u003eftp_upload\u003c/code\u003e, \u003ccode\u003eaws_s3\u003c/code\u003e, \u003ccode\u003edata_append\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly run this action for leads or calls matching these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eApply these additional tokens to the lead or call when this action runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eApply these Custom Field Mapping groups to this action.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of this action, shown in the schedule builder.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\n\u003cp\u003eAssign this action to an Action Group so it can also run from an agent status change or a matched transcription.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule Action Group}[/api/docs/1.0/schedule_action_groups/index.html]. Refer to: {/api/docs/1.0/schedule_action_groups}[/api/docs/1.0/schedule_action_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_wait_rule_group_id","full_name":"lead_wait_rule_group_id","description":"\n\u003cp\u003eThe Lead Wait Rule Group whose rules determine how long to wait, used when action_wait_type is lead_wait_rule_group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Lead Wait Rule Group}[/api/docs/1.0/lead_wait_rule_groups/index.html]. Refer to: {/api/docs/1.0/lead_wait_rule_groups}[/api/docs/1.0/lead_wait_rule_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eThe provider configuration used to place this action’s calls, SMS, or other outbound communication.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"sub_action","full_name":"sub_action","description":"\n\u003cp\u003eA sub action recognized by the action’s integration, such as send_email or add_to_campaign.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_one_to_lead_priority","full_name":"add_one_to_lead_priority","description":"\n\u003cp\u003eWhen enabled, increases the lead’s dial priority each time this action runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"change_instant_agent_dial_mode","full_name":"change_instant_agent_dial_mode","description":"\n\u003cp\u003eSwitch how the lead is dialed by an Instant Agent. Accepts dial_with_instant_agent or dial_with_ivr.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"change_contact_caller_permission_required","full_name":"change_contact_caller_permission_required","description":"\n\u003cp\u003eChange whether an agent’s permission is required before connecting this lead’s caller. Accepts apply_required or remove_required.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_wait_type","full_name":"action_wait_type","description":"\n\u003cp\u003eHow long to wait before continuing. Accepts seconds, minutes, hours, days, time_of_day, or lead_wait_rule_group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_seconds","full_name":"wait_seconds","description":"\n\u003cp\u003eThe number of seconds to wait, used when action_wait_type is seconds.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_minutes","full_name":"wait_minutes","description":"\n\u003cp\u003eThe number of minutes to wait, used when action_wait_type is minutes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_hours","full_name":"wait_hours","description":"\n\u003cp\u003eThe number of hours to wait, used when action_wait_type is hours.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_days","full_name":"wait_days","description":"\n\u003cp\u003eThe number of days to wait, used when action_wait_type is days.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_until_day_of_week","full_name":"wait_until_day_of_week","description":"\n\u003cp\u003eThe day to wait until, used when action_wait_type is time_of_day. Accepts today, tomorrow, next_week, next_month, or a day number (0 for Sunday through 6 for Saturday).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_until_hour","full_name":"wait_until_hour","description":"\n\u003cp\u003eThe hour of the day to wait until (0-23), used when action_wait_type is time_of_day.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_until_minute","full_name":"wait_until_minute","description":"\n\u003cp\u003eThe minute of the hour to wait until (0-59), used when action_wait_type is time_of_day.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"during_daylight_hours","full_name":"during_daylight_hours","description":"\n\u003cp\u003eWhen enabled, this action only proceeds during the schedule’s daylight hours; otherwise it waits until daylight hours resume.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"when_buyer_available","full_name":"when_buyer_available","description":"\n\u003cp\u003eWhen enabled, this action waits until a buyer is available before proceeding.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"when_buyer_would_convert","full_name":"when_buyer_would_convert","description":"\n\u003cp\u003eWhen enabled, this action waits until the lead would convert with an available buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"choice_action_type","full_name":"choice_action_type","description":"\n\u003cp\u003eWhat this action does when it runs. Accepts none or exit_schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sms_body","full_name":"sms_body","description":"\n\u003cp\u003eThe text message to send. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_email","full_name":"custom_email","description":"\n\u003cp\u003eSend to this email address instead of the lead’s email. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_from","full_name":"email_from","description":"\n\u003cp\u003eThe from email address.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_from_name","full_name":"email_from_name","description":"\n\u003cp\u003eThe from name displayed on the email.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_to_name","full_name":"email_to_name","description":"\n\u003cp\u003eThe name displayed for the recipient.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_title","full_name":"email_title","description":"\n\u003cp\u003eThe email subject line. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_body","full_name":"email_body","description":"\n\u003cp\u003eThe email body content. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_domain","full_name":"email_domain","description":"\n\u003cp\u003eThe sending domain used for this email.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_type","full_name":"email_type","description":"\n\u003cp\u003eThe format of the outgoing email, such as html or text.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mailchimp_list_id","full_name":"mailchimp_list_id","description":"\n\u003cp\u003eThe Mailchimp list id leads are added to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_id","full_name":"campaign_id","description":"\n\u003cp\u003eThe campaign id in the connected integration that this action applies to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_custom_caller_id","full_name":"use_custom_caller_id","description":"\n\u003cp\u003eWhen enabled, uses custom_caller_id instead of the lead’s number as the caller id for this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_caller_id","full_name":"custom_caller_id","description":"\n\u003cp\u003eThe caller id to use when use_custom_caller_id is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_custom_caller_number","full_name":"use_custom_caller_number","description":"\n\u003cp\u003eWhen enabled, uses custom_caller_number_id instead of the schedule’s number to dial the lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_caller_number_id","full_name":"custom_caller_number_id","description":"\n\u003cp\u003eThe number to dial from when use_custom_caller_number is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"lead_cycle_dial_number","full_name":"lead_cycle_dial_number","description":"\n\u003cp\u003eWhen enabled, clears the lead’s assigned dial number so a new one is chosen the next time it’s dialed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_cycle_sms_number","full_name":"lead_cycle_sms_number","description":"\n\u003cp\u003eWhen enabled, clears the lead’s assigned SMS number so a new one is chosen the next time it sends SMS.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n\u003cp\u003eOnly run this action for calls with this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"parent_outgoing_webhook_id","full_name":"parent_outgoing_webhook_id","description":"\n\u003cp\u003eThe outgoing webhook this action was generated from, when it fires alongside a webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"add_to_schedule_id","full_name":"add_to_schedule_id","description":"\n\u003cp\u003eThe schedule to add or move the lead to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"reassign_to_schedule","full_name":"reassign_to_schedule","description":"\n\u003cp\u003eWhen enabled, moves the lead to the target schedule instead of adding it as a new lead there.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_contact_field_validations","full_name":"skip_contact_field_validations","description":"\n\u003cp\u003eWhen enabled, skips contact field validation when adding the lead to the target schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_unblock_contact","full_name":"lead_unblock_contact","description":"\n\u003cp\u003eWhen enabled, unblocks the caller’s number if it was previously blocked.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_update_only","full_name":"lead_update_only","description":"\n\u003cp\u003eWhen enabled, only updates a matching existing lead on the target schedule instead of creating a new one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_expire_existing","full_name":"lead_expire_existing","description":"\n\u003cp\u003eWhen enabled, expires any existing matching leads on the target schedule before adding this one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_delete_existing","full_name":"lead_delete_existing","description":"\n\u003cp\u003eWhen enabled, deletes any existing matching leads on the target schedule before adding this one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_restart_schedule","full_name":"lead_restart_schedule","description":"\n\u003cp\u003eWhen enabled, restarts the schedule for the lead this action adds or updates.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_assign_trackdrive_number","full_name":"lead_assign_trackdrive_number","description":"\n\u003cp\u003eWhen enabled, assigns a dialing number to the lead this action adds or updates.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_assign_sms_number","full_name":"lead_assign_sms_number","description":"\n\u003cp\u003eWhen enabled, assigns an SMS number to the lead this action adds or updates.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_update_all_matching_leads","full_name":"lead_update_all_matching_leads","description":"\n\u003cp\u003eWhen enabled, applies this lead’s updated data to every other lead with a matching phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_hours_to_expire","full_name":"lead_hours_to_expire","description":"\n\u003cp\u003eThe number of hours before a lead added by this action expires.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_max_contact_attempts","full_name":"lead_max_contact_attempts","description":"\n\u003cp\u003eThe maximum number of contact attempts allowed for a lead added by this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_block_type","full_name":"lead_block_type","description":"\n\u003cp\u003eWhether to block the caller on this schedule’s suppression list only, or across the entire company. Accepts schedule, or leave blank for the whole company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_public_key","full_name":"auth_public_key","description":"\n\u003cp\u003eThe AWS access key id used to authenticate to the S3 bucket for this upload.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_secret_key","full_name":"auth_secret_key","description":"\n\u003cp\u003eThe AWS secret access key used to authenticate to the S3 bucket for this upload.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"aws_region","full_name":"aws_region","description":"\n\u003cp\u003eThe AWS region of the S3 bucket, e.g. us-east-1.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_hostname","full_name":"ftp_hostname","description":"\n\u003cp\u003eThe FTP or S3 hostname, or S3 bucket name, to upload to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_username","full_name":"ftp_username","description":"\n\u003cp\u003eThe username used to authenticate to the FTP server.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_password","full_name":"ftp_password","description":"\n\u003cp\u003eThe password used to authenticate to the FTP server.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_directory_path","full_name":"ftp_directory_path","description":"\n\u003cp\u003eThe directory path the file is uploaded to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_file_name","full_name":"ftp_file_name","description":"\n\u003cp\u003eThe file name used for the uploaded file.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_generate_directory","full_name":"ftp_generate_directory","description":"\n\u003cp\u003eWhen enabled, generates the destination directory if it doesn’t already exist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_upload_remote_file","full_name":"ftp_upload_remote_file","description":"\n\u003cp\u003eWhen enabled, downloads and uploads the file at ftp_remote_file_url instead of ftp_contents_to_upload.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_remote_file_url","full_name":"ftp_remote_file_url","description":"\n\u003cp\u003eThe URL of a file to download and upload, used when ftp_upload_remote_file is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_contents_to_upload","full_name":"ftp_contents_to_upload","description":"\n\u003cp\u003eThe text content to upload as a file, used when ftp_upload_remote_file is disabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_sftp","full_name":"use_sftp","description":"\n\u003cp\u003eWhen enabled, uploads over SFTP instead of FTP.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n\u003cp\u003eThe Data Append Group this action runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Data Append Group}[/api/docs/1.0/data_append_groups/index.html]. Refer to: {/api/docs/1.0/data_append_groups}[/api/docs/1.0/data_append_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_control_action_id","full_name":"call_control_action_id","description":"\n\u003cp\u003eRun this Call Action when the action fires.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Call Control Action}[/api/docs/1.0/call_control_actions/index.html]. Refer to: {/api/docs/1.0/call_control_actions}[/api/docs/1.0/call_control_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key_press_flow_id","full_name":"key_press_flow_id","description":"\n\u003cp\u003eThe Key Press Flow this action uses.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow}[/api/docs/1.0/key_press_flows/index.html]. Refer to: {/api/docs/1.0/key_press_flows}[/api/docs/1.0/key_press_flows/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_retarget_id","full_name":"lead_retarget_id","description":"\n\u003cp\u003eThe Lead Retarget rule this action applies.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Lead Retarget}[/api/docs/1.0/lead_retargets/index.html]. Refer to: {/api/docs/1.0/lead_retargets}[/api/docs/1.0/lead_retargets/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eThe schedule this action belongs to.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_relation","full_name":"owner_relation","description":"\n\u003cp\u003eWhich action list this action belongs to, such as the schedule’s main actions or its End Of Schedule Actions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eactions\u003c/code\u003e, \u003ccode\u003eend_of_schedule_actions\u003c/code\u003e, \u003ccode\u003ewebhook_actions\u003c/code\u003e, \u003ccode\u003ecall_disposition_actions\u003c/code\u003e, \u003ccode\u003ecall_control_actions\u003c/code\u003e, \u003ccode\u003ekey_press_flows\u003c/code\u003e, \u003ccode\u003elead_retarget_actions\u003c/code\u003e, \u003ccode\u003eschedule_actions\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_type","full_name":"action_type","description":"\n\u003cp\u003eThe type of action to perform, such as dial, sms, wait, or webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOnly run this action for leads or calls matching these tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eApply these additional tokens to the lead or call when this action runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eApply these Custom Field Mapping groups to this action.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of this action, shown in the schedule builder.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\n\u003cp\u003eAssign this action to an Action Group so it can also run from an agent status change or a matched transcription.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule Action Group}[/api/docs/1.0/schedule_action_groups/index.html]. Refer to: {/api/docs/1.0/schedule_action_groups}[/api/docs/1.0/schedule_action_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_wait_rule_group_id","full_name":"lead_wait_rule_group_id","description":"\n\u003cp\u003eThe Lead Wait Rule Group whose rules determine how long to wait, used when action_wait_type is lead_wait_rule_group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Lead Wait Rule Group}[/api/docs/1.0/lead_wait_rule_groups/index.html]. Refer to: {/api/docs/1.0/lead_wait_rule_groups}[/api/docs/1.0/lead_wait_rule_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\n\u003cp\u003eThe provider configuration used to place this action’s calls, SMS, or other outbound communication.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"sub_action","full_name":"sub_action","description":"\n\u003cp\u003eA sub action recognized by the action’s integration, such as send_email or add_to_campaign.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_one_to_lead_priority","full_name":"add_one_to_lead_priority","description":"\n\u003cp\u003eWhen enabled, increases the lead’s dial priority each time this action runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"change_instant_agent_dial_mode","full_name":"change_instant_agent_dial_mode","description":"\n\u003cp\u003eSwitch how the lead is dialed by an Instant Agent. Accepts dial_with_instant_agent or dial_with_ivr.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"change_contact_caller_permission_required","full_name":"change_contact_caller_permission_required","description":"\n\u003cp\u003eChange whether an agent’s permission is required before connecting this lead’s caller. Accepts apply_required or remove_required.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_wait_type","full_name":"action_wait_type","description":"\n\u003cp\u003eHow long to wait before continuing. Accepts seconds, minutes, hours, days, time_of_day, or lead_wait_rule_group.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_seconds","full_name":"wait_seconds","description":"\n\u003cp\u003eThe number of seconds to wait, used when action_wait_type is seconds.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_minutes","full_name":"wait_minutes","description":"\n\u003cp\u003eThe number of minutes to wait, used when action_wait_type is minutes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_hours","full_name":"wait_hours","description":"\n\u003cp\u003eThe number of hours to wait, used when action_wait_type is hours.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_days","full_name":"wait_days","description":"\n\u003cp\u003eThe number of days to wait, used when action_wait_type is days.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_until_day_of_week","full_name":"wait_until_day_of_week","description":"\n\u003cp\u003eThe day to wait until, used when action_wait_type is time_of_day. Accepts today, tomorrow, next_week, next_month, or a day number (0 for Sunday through 6 for Saturday).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_until_hour","full_name":"wait_until_hour","description":"\n\u003cp\u003eThe hour of the day to wait until (0-23), used when action_wait_type is time_of_day.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_until_minute","full_name":"wait_until_minute","description":"\n\u003cp\u003eThe minute of the hour to wait until (0-59), used when action_wait_type is time_of_day.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"during_daylight_hours","full_name":"during_daylight_hours","description":"\n\u003cp\u003eWhen enabled, this action only proceeds during the schedule’s daylight hours; otherwise it waits until daylight hours resume.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"when_buyer_available","full_name":"when_buyer_available","description":"\n\u003cp\u003eWhen enabled, this action waits until a buyer is available before proceeding.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"when_buyer_would_convert","full_name":"when_buyer_would_convert","description":"\n\u003cp\u003eWhen enabled, this action waits until the lead would convert with an available buyer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"choice_action_type","full_name":"choice_action_type","description":"\n\u003cp\u003eWhat this action does when it runs. Accepts none or exit_schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sms_body","full_name":"sms_body","description":"\n\u003cp\u003eThe text message to send. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_email","full_name":"custom_email","description":"\n\u003cp\u003eSend to this email address instead of the lead’s email. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_from","full_name":"email_from","description":"\n\u003cp\u003eThe from email address.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_from_name","full_name":"email_from_name","description":"\n\u003cp\u003eThe from name displayed on the email.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_to_name","full_name":"email_to_name","description":"\n\u003cp\u003eThe name displayed for the recipient.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_title","full_name":"email_title","description":"\n\u003cp\u003eThe email subject line. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_body","full_name":"email_body","description":"\n\u003cp\u003eThe email body content. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_domain","full_name":"email_domain","description":"\n\u003cp\u003eThe sending domain used for this email.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_type","full_name":"email_type","description":"\n\u003cp\u003eThe format of the outgoing email, such as html or text.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mailchimp_list_id","full_name":"mailchimp_list_id","description":"\n\u003cp\u003eThe Mailchimp list id leads are added to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"campaign_id","full_name":"campaign_id","description":"\n\u003cp\u003eThe campaign id in the connected integration that this action applies to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_custom_caller_id","full_name":"use_custom_caller_id","description":"\n\u003cp\u003eWhen enabled, uses custom_caller_id instead of the lead’s number as the caller id for this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_caller_id","full_name":"custom_caller_id","description":"\n\u003cp\u003eThe caller id to use when use_custom_caller_id is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_custom_caller_number","full_name":"use_custom_caller_number","description":"\n\u003cp\u003eWhen enabled, uses custom_caller_number_id instead of the schedule’s number to dial the lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_caller_number_id","full_name":"custom_caller_number_id","description":"\n\u003cp\u003eThe number to dial from when use_custom_caller_number is enabled.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"lead_cycle_dial_number","full_name":"lead_cycle_dial_number","description":"\n\u003cp\u003eWhen enabled, clears the lead’s assigned dial number so a new one is chosen the next time it’s dialed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_cycle_sms_number","full_name":"lead_cycle_sms_number","description":"\n\u003cp\u003eWhen enabled, clears the lead’s assigned SMS number so a new one is chosen the next time it sends SMS.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\n\u003cp\u003eOnly run this action for calls with this disposition.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"parent_outgoing_webhook_id","full_name":"parent_outgoing_webhook_id","description":"\n\u003cp\u003eThe outgoing webhook this action was generated from, when it fires alongside a webhook.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"add_to_schedule_id","full_name":"add_to_schedule_id","description":"\n\u003cp\u003eThe schedule to add or move the lead to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"reassign_to_schedule","full_name":"reassign_to_schedule","description":"\n\u003cp\u003eWhen enabled, moves the lead to the target schedule instead of adding it as a new lead there.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_contact_field_validations","full_name":"skip_contact_field_validations","description":"\n\u003cp\u003eWhen enabled, skips contact field validation when adding the lead to the target schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_unblock_contact","full_name":"lead_unblock_contact","description":"\n\u003cp\u003eWhen enabled, unblocks the caller’s number if it was previously blocked.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_update_only","full_name":"lead_update_only","description":"\n\u003cp\u003eWhen enabled, only updates a matching existing lead on the target schedule instead of creating a new one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_expire_existing","full_name":"lead_expire_existing","description":"\n\u003cp\u003eWhen enabled, expires any existing matching leads on the target schedule before adding this one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_delete_existing","full_name":"lead_delete_existing","description":"\n\u003cp\u003eWhen enabled, deletes any existing matching leads on the target schedule before adding this one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_restart_schedule","full_name":"lead_restart_schedule","description":"\n\u003cp\u003eWhen enabled, restarts the schedule for the lead this action adds or updates.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_assign_trackdrive_number","full_name":"lead_assign_trackdrive_number","description":"\n\u003cp\u003eWhen enabled, assigns a dialing number to the lead this action adds or updates.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_assign_sms_number","full_name":"lead_assign_sms_number","description":"\n\u003cp\u003eWhen enabled, assigns an SMS number to the lead this action adds or updates.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_update_all_matching_leads","full_name":"lead_update_all_matching_leads","description":"\n\u003cp\u003eWhen enabled, applies this lead’s updated data to every other lead with a matching phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_hours_to_expire","full_name":"lead_hours_to_expire","description":"\n\u003cp\u003eThe number of hours before a lead added by this action expires.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_max_contact_attempts","full_name":"lead_max_contact_attempts","description":"\n\u003cp\u003eThe maximum number of contact attempts allowed for a lead added by this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_block_type","full_name":"lead_block_type","description":"\n\u003cp\u003eWhether to block the caller on this schedule’s suppression list only, or across the entire company. Accepts schedule, or leave blank for the whole company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_public_key","full_name":"auth_public_key","description":"\n\u003cp\u003eThe AWS access key id used to authenticate to the S3 bucket for this upload.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_secret_key","full_name":"auth_secret_key","description":"\n\u003cp\u003eThe AWS secret access key used to authenticate to the S3 bucket for this upload.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"aws_region","full_name":"aws_region","description":"\n\u003cp\u003eThe AWS region of the S3 bucket, e.g. us-east-1.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_hostname","full_name":"ftp_hostname","description":"\n\u003cp\u003eThe FTP or S3 hostname, or S3 bucket name, to upload to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_username","full_name":"ftp_username","description":"\n\u003cp\u003eThe username used to authenticate to the FTP server.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_password","full_name":"ftp_password","description":"\n\u003cp\u003eThe password used to authenticate to the FTP server.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_directory_path","full_name":"ftp_directory_path","description":"\n\u003cp\u003eThe directory path the file is uploaded to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_file_name","full_name":"ftp_file_name","description":"\n\u003cp\u003eThe file name used for the uploaded file.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_generate_directory","full_name":"ftp_generate_directory","description":"\n\u003cp\u003eWhen enabled, generates the destination directory if it doesn’t already exist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_upload_remote_file","full_name":"ftp_upload_remote_file","description":"\n\u003cp\u003eWhen enabled, downloads and uploads the file at ftp_remote_file_url instead of ftp_contents_to_upload.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_remote_file_url","full_name":"ftp_remote_file_url","description":"\n\u003cp\u003eThe URL of a file to download and upload, used when ftp_upload_remote_file is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ftp_contents_to_upload","full_name":"ftp_contents_to_upload","description":"\n\u003cp\u003eThe text content to upload as a file, used when ftp_upload_remote_file is disabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_sftp","full_name":"use_sftp","description":"\n\u003cp\u003eWhen enabled, uploads over SFTP instead of FTP.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_append_group_id","full_name":"data_append_group_id","description":"\n\u003cp\u003eThe Data Append Group this action runs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Data Append Group}[/api/docs/1.0/data_append_groups/index.html]. Refer to: {/api/docs/1.0/data_append_groups}[/api/docs/1.0/data_append_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":"Creates an agent account, including its contact details and call center, through a simplified setup 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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfirst_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nemail\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nphone_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naddress_state\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naddress_city\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naddress_country\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naddress_zip\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naddress_line1\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naddress_line2\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncollaborator_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninternal_password\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprofile_image_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_internal\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninternal_username\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsoftphone_sip_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsoftphone_password\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsoftphone_username\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_center_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eFirst Name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_internal","full_name":"is_internal","description":"\n\u003cp\u003eInternal agents only have access to your company. The create response returns the agent’s password once as internal_password to an administrator or manager; an administrator or manager can generate a new one on the agent’s page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_type","full_name":"buyer_type","description":"\n\u003cp\u003eWhat type of Agent is this? Either quality_assurance or buyer\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"internal_username","full_name":"internal_username","description":"\n\u003cp\u003eUsername\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eLast Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_name","full_name":"company_name","description":"\n\u003cp\u003eCompany Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_number","description":"\n\u003cp\u003ePhone Number\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_state","full_name":"address_state","description":"\n\u003cp\u003eAddress State\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_city","full_name":"address_city","description":"\n\u003cp\u003eAddress City\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_country","full_name":"address_country","description":"\n\u003cp\u003eAddress Country\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_zip","full_name":"address_zip","description":"\n\u003cp\u003eAddress Zip\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_line1","full_name":"address_line1","description":"\n\u003cp\u003eAddress Line1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_line2","full_name":"address_line2","description":"\n\u003cp\u003eAddress Line2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_center_id","full_name":"call_center_id","description":"\n\u003cp\u003eDoes this agent belong to a call center?\u003c/p\u003e\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":[],"deprecated":false},{"name":"profile_image","full_name":"profile_image","description":"\n\u003cp\u003eA photo to display on the agent’s profile, 200px by 200px.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_profile_image","full_name":"remove_profile_image","description":"\n\u003cp\u003eSet to true to remove the agent’s existing profile photo.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"agent_number","full_name":"agent_number","description":"\n\u003cp\u003eThe phone number or SIP address calls are forwarded to for this agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eThe phone number shown as the caller ID to consumers when this agent places outbound calls.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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":[{"name":"first_name","full_name":"first_name","description":"\n\u003cp\u003eFirst Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_internal","full_name":"is_internal","description":"\n\u003cp\u003eInternal agents only have access to your company. The create response returns the agent’s password once as internal_password to an administrator or manager; an administrator or manager can generate a new one on the agent’s page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_type","full_name":"buyer_type","description":"\n\u003cp\u003eWhat type of Agent is this? Either quality_assurance or buyer\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"internal_username","full_name":"internal_username","description":"\n\u003cp\u003eUsername\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eLast Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_name","full_name":"company_name","description":"\n\u003cp\u003eCompany Name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"phone_number","full_name":"phone_number","description":"\n\u003cp\u003ePhone Number\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_state","full_name":"address_state","description":"\n\u003cp\u003eAddress State\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_city","full_name":"address_city","description":"\n\u003cp\u003eAddress City\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_country","full_name":"address_country","description":"\n\u003cp\u003eAddress Country\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_zip","full_name":"address_zip","description":"\n\u003cp\u003eAddress Zip\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_line1","full_name":"address_line1","description":"\n\u003cp\u003eAddress Line1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address_line2","full_name":"address_line2","description":"\n\u003cp\u003eAddress Line2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_center_id","full_name":"call_center_id","description":"\n\u003cp\u003eDoes this agent belong to a call center?\u003c/p\u003e\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":[],"deprecated":false},{"name":"profile_image","full_name":"profile_image","description":"\n\u003cp\u003eA photo to display on the agent’s profile, 200px by 200px.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_profile_image","full_name":"remove_profile_image","description":"\n\u003cp\u003eSet to true to remove the agent’s existing profile photo.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"agent_number","full_name":"agent_number","description":"\n\u003cp\u003eThe phone number or SIP address calls are forwarded to for this agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eThe phone number shown as the caller ID to consumers when this agent places outbound calls.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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":"Distributions","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntarget_schedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eSchedule\u003c/p\u003e\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":[],"deprecated":false},{"name":"target_schedule_id","full_name":"target_schedule_id","description":"\n\u003cp\u003eTarget Schedule\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eThe lead will be moved to the target schedule when it matches this Filter Group.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eLeads matching these tokens will be moved to the target schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eSchedule\u003c/p\u003e\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":[],"deprecated":false},{"name":"target_schedule_id","full_name":"target_schedule_id","description":"\n\u003cp\u003eTarget Schedule\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eThe lead will be moved to the target schedule when it matches this Filter Group.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eLeads matching these tokens will be moved to the target schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eAttach an existing Record Token Filter instead of building one from token_value_ids or record_token_filter_list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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\u003cp\u003eSchedule\u003c/p\u003e\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":[],"deprecated":false},{"name":"target_schedule_id","full_name":"target_schedule_id","description":"\n\u003cp\u003eTarget Schedule\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eThe lead will be moved to the target schedule when it matches this Filter Group.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eLeads matching these tokens will be moved to the target schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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_ring_pools":{"doc_url":"/api/docs/1.0/schedule_ring_pools","id":"schedule_ring_pools","api_url":"/api","name":"Schedules: Number Pools","short_description":"Assign multiple number pools to a schedule with filters. When placing outbound calls, the system evaluates filters in sort order and uses the first matching number pool. When no filters match, the last number pool in the list is used as the fallback.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_ring_pools/index","name":"index","apis":[{"api_url":"/api/v1/schedule_ring_pools","http_method":"GET","short_description":"List Schedule Number Pool records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_ring_pools/new","name":"new","apis":[{"api_url":"/api/v1/schedule_ring_pools/new","http_method":"GET","short_description":"Build Schedule Number Pool with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eSchedule\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eNumber Pool\u003c/p\u003e\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":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eThis Number Pool will be used for outbound calls when the call matches this Filter Group.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOutbound calls matching these tokens will use this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_ring_pools/create","name":"create","apis":[{"api_url":"/api/v1/schedule_ring_pools","http_method":"POST","short_description":"Create Schedule Number Pool.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eSchedule\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eNumber Pool\u003c/p\u003e\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":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eThis Number Pool will be used for outbound calls when the call matches this Filter Group.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOutbound calls matching these tokens will use this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eAttach an existing Record Token Filter instead of building one from token_value_ids or record_token_filter_list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_ring_pools/show","name":"show","apis":[{"api_url":"/api/v1/schedule_ring_pools/:id","http_method":"GET","short_description":"Get Schedule 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/schedule_ring_pools/update","name":"update","apis":[{"api_url":"/api/v1/schedule_ring_pools/:id","http_method":"PUT","short_description":"Update Schedule Number Pool by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eSchedule\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eNumber Pool\u003c/p\u003e\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":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eThis Number Pool will be used for outbound calls when the call matches this Filter Group.\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eOutbound calls matching these tokens will use this Number Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_ring_pools/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_ring_pools/:id","http_method":"DELETE","short_description":"Destroy Schedule Number Pool 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\u003cp\u003eSchedule internal id\u003c/p\u003e\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":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eSchedule internal id\u003c/p\u003e\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":[],"deprecated":false}],"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\u003cp\u003eSchedule internal id\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe trigger name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_type","full_name":"trigger_type","description":"\n\u003cp\u003eThe schedule ends when the lead has taken this action.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003etokens_match\u003c/code\u003e, \u003ccode\u003eexpired\u003c/code\u003e, \u003ccode\u003ebuyer_connected\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003edial\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expire_minutes","full_name":"expire_minutes","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expire_timestamp_name","full_name":"expire_timestamp_name","description":"\n\u003cp\u003eWhich lead timestamp expire_minutes is measured from, such as created_at, first_queued_at, or first_action_at.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003efirst_queued_at\u003c/code\u003e, \u003ccode\u003efirst_action_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eThe first trigger matching the lead will be used.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThese extra tokens will be applied to leads that exit the schedule through this trigger.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eSchedule internal id\u003c/p\u003e\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":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe trigger name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_type","full_name":"trigger_type","description":"\n\u003cp\u003eThe schedule ends when the lead has taken this action.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003etokens_match\u003c/code\u003e, \u003ccode\u003eexpired\u003c/code\u003e, \u003ccode\u003ebuyer_connected\u003c/code\u003e, \u003ccode\u003ebuyer_converted\u003c/code\u003e, \u003ccode\u003edial\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expire_minutes","full_name":"expire_minutes","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expire_timestamp_name","full_name":"expire_timestamp_name","description":"\n\u003cp\u003eWhich lead timestamp expire_minutes is measured from, such as created_at, first_queued_at, or first_action_at.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003efirst_queued_at\u003c/code\u003e, \u003ccode\u003efirst_action_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eThe first trigger matching the lead will be used.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eThese extra tokens will be applied to leads that exit the schedule through this trigger.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eThe callback will be made against this call.\u003c/p\u003e\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":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eThe callback will be made against this lead.\u003c/p\u003e\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":[],"deprecated":false}],"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\u003cp\u003eThe telephone number for the consumer who will receive a callback.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule that the callback will be associated with.\u003c/p\u003e\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":[],"deprecated":false},{"name":"call_id","full_name":"call_id","description":"\n\u003cp\u003eThe callback will be made against this call.\u003c/p\u003e\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":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eThe callback will be made against this lead.\u003c/p\u003e\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":[],"deprecated":false},{"name":"connect_with","full_name":"connect_with","description":"\n\u003cp\u003eWho Should The Consumer Talk To?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eme\u003c/code\u003e, \u003ccode\u003eanyone\u003c/code\u003e, \u003ccode\u003econnect_with_buyer_id\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_at","full_name":"place_call_at","description":"\n\u003cp\u003eWhen should the callback occur?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_time_zone","full_name":"place_call_time_zone","description":"\n\u003cp\u003eThe time zone that will be used when parsing place_call_at\u003c/p\u003e\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":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eThe callback will be made against this call.\u003c/p\u003e\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":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eThe callback will be made against this lead.\u003c/p\u003e\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":[],"deprecated":false}],"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\u003cp\u003eWho Should The Consumer Talk To?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eme\u003c/code\u003e, \u003ccode\u003eanyone\u003c/code\u003e, \u003ccode\u003econnect_with_buyer_id\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_at","full_name":"place_call_at","description":"\n\u003cp\u003eWhen should the callback occur?\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:24 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_time_zone","full_name":"place_call_time_zone","description":"\n\u003cp\u003eThe time zone that will be used when parsing place_call_at\u003c/p\u003e\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":[],"deprecated":false}],"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 lead distribution and dialing configuration that controls how leads flow through your account and get called.","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","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003esortable_order\u003c/code\u003e, \u003ccode\u003eoffer_id\u003c/code\u003e, \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003epaused\u003c/code\u003e, \u003ccode\u003eoffer_id\u003c/code\u003e, \u003ccode\u003eleads_api_key\u003c/code\u003e, \u003ccode\u003etime_zone\u003c/code\u003e, \u003ccode\u003eschedule_type\u003c/code\u003e, \u003ccode\u003enumbers_count\u003c/code\u003e, \u003ccode\u003elast_call_at\u003c/code\u003e, \u003ccode\u003ecalls_count\u003c/code\u003e, \u003ccode\u003einstant_agent_dial_weight\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003erecent_calls_count\u003c/code\u003e, \u003ccode\u003euse_do_not_call\u003c/code\u003e, \u003ccode\u003euse_machine_detection\u003c/code\u003e, \u003ccode\u003eaction_dial_skip_mobile\u003c/code\u003e, \u003ccode\u003eoff_hook_enabled\u003c/code\u003e, \u003ccode\u003ereal_time_priority\u003c/code\u003e, \u003ccode\u003edial_caller_name\u003c/code\u003e, \u003ccode\u003edaylight_hours_open\u003c/code\u003e, \u003ccode\u003edaylight_hours_close\u003c/code\u003e, \u003ccode\u003eleads_sort_order_type\u003c/code\u003e, \u003ccode\u003echecked_leads_agent_dial_actions_at\u003c/code\u003e, \u003ccode\u003echecked_leads_no_match_actions_at\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_token\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nleads_api_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntime_zone\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_leads_per_remote_ip_interval\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_leads_per_remote_ip\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_call_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncalls_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecent_calls_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_sms_provider_configuration_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_sms_ring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_sms_number_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_sms_use_ring_pool\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_dial_use_ring_pool\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nduring_daylight_hours\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_do_not_call\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\navailable_cc_percentage\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncalls_on_hold_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_machine_detection\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_dial_skip_mobile\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nskip_placing_calls_until_agent_count_exceeds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nunpaused_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused_by_user_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndial_caller_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndaylight_hours_open\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndaylight_hours_close\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nleads_sort_order_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nend_of_schedule_action_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_trigger_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_end_of_schedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_end_of_schedule_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_end_of_schedule_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_scheduled_callback_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_scheduled_callback_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_scheduled_callback_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmachine_detection_record_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmachine_detection_record_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmachine_detection_record_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 Schedule with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Schedule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_type","full_name":"schedule_type","description":"\n\u003cp\u003eThe type of schedule to create, eg \u003ccode\u003econtact_caller\u003c/code\u003e or \u003ccode\u003elead_distribution\u003c/code\u003e. Cannot be changed after creation.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer\u003c/p\u003e\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":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of the record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePaused\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this schedule, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_enabled","full_name":"off_hook_enabled","description":"\n\u003cp\u003eTurns on Instant Agent Mode, which sends calls to logged-in agents through \u003ccode\u003edial_agents_number_id\u003c/code\u003e instead of a Ring Pool or Number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_agents_number_id","full_name":"dial_agents_number_id","description":"\n\u003cp\u003eThe number agents call in to when \u003ccode\u003eoff_hook_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"action_dial_with_type","full_name":"action_dial_with_type","description":"\n\u003cp\u003eWhether outbound dialing from this schedule uses a single Number or a Ring Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enumber\u003c/th\u003e\u003ctd\u003eDial leads using a single tracking number.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ering_pool\u003c/th\u003e\u003ctd\u003eDial leads using a pool of tracking numbers.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_consumers_number_id","full_name":"dial_consumers_number_id","description":"\n\u003cp\u003eThe number used to dial leads when \u003ccode\u003eaction_dial_with_type\u003c/code\u003e is \u003ccode\u003enumber\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"dial_caller_name","full_name":"dial_caller_name","description":"\n\u003cp\u003eThe caller ID name shown to leads when this schedule places a call. Limited to 15 characters.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_dial_skip_mobile","full_name":"action_dial_skip_mobile","description":"\n\u003cp\u003eSkip dialing lead phone numbers identified as mobile.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_tcpa_actions_today","full_name":"enforce_tcpa_actions_today","description":"\n\u003cp\u003eOnly run TCPA-restricted actions when the current day still allows contacting the lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_placing_calls_until_agent_count_exceeds","full_name":"skip_placing_calls_until_agent_count_exceeds","description":"\n\u003cp\u003eDelay placing outbound calls until at least this many agents are logged into the offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_is_available_with_qa_agents","full_name":"buyer_is_available_with_qa_agents","description":"\n\u003cp\u003eTreat buyers as available for IVR dialing while agents are in QA.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"instant_agent_dial_weight","full_name":"instant_agent_dial_weight","description":"\n\u003cp\u003eThe relative weight given to this schedule when Instant Agent Mode distributes leads across multiple schedules.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"distribute_calls_across_schedules","full_name":"distribute_calls_across_schedules","description":"\n\u003cp\u003eAllow Instant Agent Mode to distribute calls for this schedule across other schedules on the same offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_sort_order_type","full_name":"leads_sort_order_type","description":"\n\u003cp\u003eThe order leads are dialed in during Instant Agent Mode, eg \u003ccode\u003efirst_in_first_out\u003c/code\u003e or \u003ccode\u003elast_in_first_out\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"real_time_priority","full_name":"real_time_priority","description":"\n\u003cp\u003eThe dial priority used when \u003ccode\u003eleads_sort_order_type\u003c/code\u003e is \u003ccode\u003elast_in_first_out\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"allow_rtp_after_hours","full_name":"allow_rtp_after_hours","description":"\n\u003cp\u003eAllow real-time-priority leads to be dialed outside of business hours.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"intersperse_leads","full_name":"intersperse_leads","description":"\n\u003cp\u003eMix in leads sorted by \u003ccode\u003eintersperse_sort_order_type\u003c/code\u003e alongside the normal dial order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"intersperse_sort_order_type","full_name":"intersperse_sort_order_type","description":"\n\u003cp\u003eThe sort order used for the interspersed leads when \u003ccode\u003eintersperse_leads\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"intersperse_percent","full_name":"intersperse_percent","description":"\n\u003cp\u003eThe percentage of dialed leads, between 5 and 95, drawn from the interspersed sort order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_cc_percentage","full_name":"available_cc_percentage","description":"\n\u003cp\u003eThe percentage of the offer’s concurrency cap this schedule may use for outbound calls. Leave blank for unlimited.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"calls_on_hold_limit","full_name":"calls_on_hold_limit","description":"\n\u003cp\u003eThe maximum number of calls this schedule will hold at once.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_expiry_seconds","full_name":"callback_expiry_seconds","description":"\n\u003cp\u003eHow long, in seconds, a scheduled callback remains valid before it expires.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"before_schedule_action_dial_next_action_seconds","full_name":"before_schedule_action_dial_next_action_seconds","description":"\n\u003cp\u003eHow long, in seconds, to wait before moving a lead to the next dial action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_for_scheduled_callbacks","full_name":"use_for_scheduled_callbacks","description":"\n\u003cp\u003eAllow leads on this schedule to be placed into scheduled callbacks.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled_automatically_place_scheduled_callbacks","full_name":"enabled_automatically_place_scheduled_callbacks","description":"\n\u003cp\u003eAutomatically place scheduled callbacks instead of requiring an agent to dial them manually.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_machine_detection","full_name":"use_machine_detection","description":"\n\u003cp\u003eUse answering machine detection on outbound calls from this schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_sms_use_ring_pool","full_name":"action_sms_use_ring_pool","description":"\n\u003cp\u003eSend SMS actions from a Ring Pool instead of a single number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_sms_ring_pool_id","full_name":"action_sms_ring_pool_id","description":"\n\u003cp\u003eThe Ring Pool used to send SMS actions when \u003ccode\u003eaction_sms_use_ring_pool\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"action_sms_number_id","full_name":"action_sms_number_id","description":"\n\u003cp\u003eThe number used to send SMS actions when \u003ccode\u003eaction_sms_use_ring_pool\u003c/code\u003e is false.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"contact_caller_permission_required","full_name":"contact_caller_permission_required","description":"\n\u003cp\u003eRequire the lead’s permission before running certain schedule actions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_caller_permission_action_types","full_name":"contact_caller_permission_action_types","description":"\n\u003cp\u003eThe action types that require contact caller permission when \u003ccode\u003econtact_caller_permission_required\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eReject leads submitted to this schedule without a \u003ccode\u003etraffic_source_id\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_traffic_source_reject_duplicates","full_name":"lead_traffic_source_reject_duplicates","description":"\n\u003cp\u003eReject a lead when another lead with the same traffic source already exists on this schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_contact_field_validations","full_name":"enforce_contact_field_validations","description":"\n\u003cp\u003eValidate submitted leads against this schedule’s contact field configuration.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minimum_caller_number_length","full_name":"minimum_caller_number_length","description":"\n\u003cp\u003eReject leads whose phone number has fewer digits than this.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_caller_number_length","full_name":"maximum_caller_number_length","description":"\n\u003cp\u003eReject leads whose phone number has more digits than this.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_duplicate_timeframe_scope","full_name":"lead_duplicate_timeframe_scope","description":"\n\u003cp\u003eWhether \u003ccode\u003elead_duplicate_timeframe\u003c/code\u003e checks for duplicates within this schedule or across the whole company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule_id\u003c/th\u003e\u003ctd\u003eDedupe against leads on this schedule only.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecompany_id\u003c/th\u003e\u003ctd\u003eDedupe against all leads in your account.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_leads_per_remote_ip","full_name":"max_leads_per_remote_ip","description":"\n\u003cp\u003eThe maximum number of leads accepted from the same remote IP within \u003ccode\u003emax_leads_per_remote_ip_interval\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_leads_per_remote_ip_interval","full_name":"max_leads_per_remote_ip_interval","description":"\n\u003cp\u003eThe interval, in seconds, over which \u003ccode\u003emax_leads_per_remote_ip\u003c/code\u003e is enforced.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_do_not_call","full_name":"use_do_not_call","description":"\n\u003cp\u003eReject leads whose number is on the Do Not Call list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_dnc_litigators","full_name":"use_dnc_litigators","description":"\n\u003cp\u003eReject leads whose number belongs to a known DNC litigator.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reject_number_not_in_service","full_name":"reject_number_not_in_service","description":"\n\u003cp\u003eReject leads whose number is not in service.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n\u003cp\u003eThe Buyer Suppression list used to suppress leads and callers on this schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"tcpa_shield_enabled","full_name":"tcpa_shield_enabled","description":"\n\u003cp\u003eCheck leads against TCPA Shield before dialing them.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tcpa_shield_integration_id","full_name":"tcpa_shield_integration_id","description":"\n\u003cp\u003eThe TCPA Shield integration used when \u003ccode\u003etcpa_shield_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"blacklist_alliance_enabled","full_name":"blacklist_alliance_enabled","description":"\n\u003cp\u003eCheck leads against Blacklist Alliance before dialing them.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blacklist_alliance_integration_id","full_name":"blacklist_alliance_integration_id","description":"\n\u003cp\u003eThe Blacklist Alliance integration used when \u003ccode\u003eblacklist_alliance_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"daylight_hours_open","full_name":"daylight_hours_open","description":"\n\u003cp\u003eThe time of day, in \u003ccode\u003eHHMM\u003c/code\u003e format using the lead’s local time zone, that daylight hours dialing opens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"daylight_hours_close","full_name":"daylight_hours_close","description":"\n\u003cp\u003eThe time of day, in \u003ccode\u003eHHMM\u003c/code\u003e format using the lead’s local time zone, that daylight hours dialing closes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_hours_open","full_name":"scheduled_callback_hours_open","description":"\n\u003cp\u003eThe time of day, in \u003ccode\u003eHHMM\u003c/code\u003e format using the schedule’s time zone, that scheduled callbacks may start being placed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_hours_close","full_name":"scheduled_callback_hours_close","description":"\n\u003cp\u003eThe time of day, in \u003ccode\u003eHHMM\u003c/code\u003e format using the schedule’s time zone, that scheduled callbacks stop being placed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003ePublish this schedule’s posting instructions page. Turning this on requires the company to have completed identity verification.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eList this schedule’s posting instructions page on the company’s public index.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe title shown on this schedule’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe rich-text description shown on this schedule’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/make_call","name":"make_call","apis":[{"api_url":"/api/v1/schedules/make_call","http_method":"POST","short_description":"Call a lead immediately","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003ePlaces an outbound call immediately. This is the endpoint to use for a “promote” / “call now” action.\u003cbr\u003e \u003cbr\u003e \u003cstrong\u003eIdentifying who to call (choose one):\u003c/strong\u003e\u003cbr\u003e • \u003cstrong\u003elead_id\u003c/strong\u003e — dials that exact existing Lead. Its number is used as \u003ccode\u003eto\u003c/code\u003e and its schedule is used to dial. Nothing new is created, so a promote never produces a duplicate lead. This is the recommended option.\u003cbr\u003e • \u003cstrong\u003elead_token\u003c/strong\u003e (a Schedule’s “Leads API Key”) or \u003cstrong\u003eschedule_id\u003c/strong\u003e — identifies the Schedule to dial from. You must also pass \u003ccode\u003eto\u003c/code\u003e (the number to dial).\u003cbr\u003e \u003cbr\u003e \u003cstrong\u003eSchedule / lead distribution routing:\u003c/strong\u003e\u003cbr\u003e The resolved schedule takes the same code path as \u003ccode\u003ePOST /api/v1/leads\u003c/code\u003e. If it is a lead-distribution (“router”) schedule, the matching distribution is resolved from the submitted \u003ccode\u003edata\u003c/code\u003e (eg \u003ccode\u003etraffic_source_id\u003c/code\u003e) and the call is routed to that distribution’s downstream target schedule. If no distribution matches, the request is rejected.\u003cbr\u003e \u003cbr\u003e \u003cstrong\u003eWhich lead gets dialed (when using lead_token/schedule_id + to):\u003c/strong\u003e\u003cbr\u003e • If a live lead is already enrolled in the resolved schedule for that number, it is reused and dialed — no duplicate is created (the “promote” case).\u003cbr\u003e • Otherwise a one-off, offer-owned lead is created and dialed. This places a single call without enrolling the contact into the schedule’s dialing cadence.\u003cbr\u003e \u003cbr\u003e \u003cstrong\u003eGuards enforced before dialing:\u003c/strong\u003e\u003cbr\u003e • The schedule must be active.\u003cbr\u003e • Account CPS (calls per second) limit.\u003cbr\u003e • DNC / contact suppression rules.\u003cbr\u003e • The same number cannot be dialed more than once every 30 seconds.\u003cbr\u003e • The destination number must be valid.\u003cbr\u003e \u003cbr\u003e Returns a serialized Call record on success. Raises errors for an unknown lead_id, an unresolvable or inactive schedule, no matching lead distribution, invalid numbers, suppressed contacts, exceeded CPS, recently-dialed numbers, or duplicate concurrent leads.\u003c/p\u003e\n","errors":[],"params":[{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eThe TrackDrive ID (UUID) of an existing Lead to dial. When provided, the call uses this exact lead — its number is dialed and its schedule is used — so \u003ccode\u003eto\u003c/code\u003e, \u003ccode\u003elead_token\u003c/code\u003e and \u003ccode\u003eschedule_id\u003c/code\u003e are not required and are ignored. This is the preferred way to promote a lead you already created, because it never creates a duplicate.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe ID of the Schedule to dial from. Must belong to the current company and be active. Use this (or \u003ccode\u003elead_token\u003c/code\u003e) together with \u003ccode\u003eto\u003c/code\u003e when you are not passing a \u003ccode\u003elead_id\u003c/code\u003e.\u003c/p\u003e\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":[],"deprecated":false},{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe token for the Schedule where you want lead to originate. Get it from: \u003ca href=\"https://trackdrive.com/schedules\"\u003etrackdrive.com/schedules\u003c/a\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"to","description":"\n\u003cp\u003eDestination phone number to dial. Must be a valid number and not suppressed. Required unless a \u003ccode\u003elead_id\u003c/code\u003e is provided (in which case the lead’s number is used).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eOptional hash of additional lead attributes (eg \u003ccode\u003etraffic_source_id\u003c/code\u003e). Used to route the lead through a lead-distribution schedule and stored on any lead that is created.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Schedule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Schedule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer\u003c/p\u003e\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":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of the record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePaused\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eYour own identifier for this schedule, used to correlate it with a record in an external system.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_enabled","full_name":"off_hook_enabled","description":"\n\u003cp\u003eTurns on Instant Agent Mode, which sends calls to logged-in agents through \u003ccode\u003edial_agents_number_id\u003c/code\u003e instead of a Ring Pool or Number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_agents_number_id","full_name":"dial_agents_number_id","description":"\n\u003cp\u003eThe number agents call in to when \u003ccode\u003eoff_hook_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"action_dial_with_type","full_name":"action_dial_with_type","description":"\n\u003cp\u003eWhether outbound dialing from this schedule uses a single Number or a Ring Pool.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enumber\u003c/th\u003e\u003ctd\u003eDial leads using a single tracking number.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ering_pool\u003c/th\u003e\u003ctd\u003eDial leads using a pool of tracking numbers.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dial_consumers_number_id","full_name":"dial_consumers_number_id","description":"\n\u003cp\u003eThe number used to dial leads when \u003ccode\u003eaction_dial_with_type\u003c/code\u003e is \u003ccode\u003enumber\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"dial_caller_name","full_name":"dial_caller_name","description":"\n\u003cp\u003eThe caller ID name shown to leads when this schedule places a call. Limited to 15 characters.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_dial_skip_mobile","full_name":"action_dial_skip_mobile","description":"\n\u003cp\u003eSkip dialing lead phone numbers identified as mobile.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_tcpa_actions_today","full_name":"enforce_tcpa_actions_today","description":"\n\u003cp\u003eOnly run TCPA-restricted actions when the current day still allows contacting the lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_placing_calls_until_agent_count_exceeds","full_name":"skip_placing_calls_until_agent_count_exceeds","description":"\n\u003cp\u003eDelay placing outbound calls until at least this many agents are logged into the offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_is_available_with_qa_agents","full_name":"buyer_is_available_with_qa_agents","description":"\n\u003cp\u003eTreat buyers as available for IVR dialing while agents are in QA.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"instant_agent_dial_weight","full_name":"instant_agent_dial_weight","description":"\n\u003cp\u003eThe relative weight given to this schedule when Instant Agent Mode distributes leads across multiple schedules.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"distribute_calls_across_schedules","full_name":"distribute_calls_across_schedules","description":"\n\u003cp\u003eAllow Instant Agent Mode to distribute calls for this schedule across other schedules on the same offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_sort_order_type","full_name":"leads_sort_order_type","description":"\n\u003cp\u003eThe order leads are dialed in during Instant Agent Mode, eg \u003ccode\u003efirst_in_first_out\u003c/code\u003e or \u003ccode\u003elast_in_first_out\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"real_time_priority","full_name":"real_time_priority","description":"\n\u003cp\u003eThe dial priority used when \u003ccode\u003eleads_sort_order_type\u003c/code\u003e is \u003ccode\u003elast_in_first_out\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"allow_rtp_after_hours","full_name":"allow_rtp_after_hours","description":"\n\u003cp\u003eAllow real-time-priority leads to be dialed outside of business hours.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"intersperse_leads","full_name":"intersperse_leads","description":"\n\u003cp\u003eMix in leads sorted by \u003ccode\u003eintersperse_sort_order_type\u003c/code\u003e alongside the normal dial order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"intersperse_sort_order_type","full_name":"intersperse_sort_order_type","description":"\n\u003cp\u003eThe sort order used for the interspersed leads when \u003ccode\u003eintersperse_leads\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"intersperse_percent","full_name":"intersperse_percent","description":"\n\u003cp\u003eThe percentage of dialed leads, between 5 and 95, drawn from the interspersed sort order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"available_cc_percentage","full_name":"available_cc_percentage","description":"\n\u003cp\u003eThe percentage of the offer’s concurrency cap this schedule may use for outbound calls. Leave blank for unlimited.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"calls_on_hold_limit","full_name":"calls_on_hold_limit","description":"\n\u003cp\u003eThe maximum number of calls this schedule will hold at once.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_expiry_seconds","full_name":"callback_expiry_seconds","description":"\n\u003cp\u003eHow long, in seconds, a scheduled callback remains valid before it expires.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"before_schedule_action_dial_next_action_seconds","full_name":"before_schedule_action_dial_next_action_seconds","description":"\n\u003cp\u003eHow long, in seconds, to wait before moving a lead to the next dial action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_for_scheduled_callbacks","full_name":"use_for_scheduled_callbacks","description":"\n\u003cp\u003eAllow leads on this schedule to be placed into scheduled callbacks.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled_automatically_place_scheduled_callbacks","full_name":"enabled_automatically_place_scheduled_callbacks","description":"\n\u003cp\u003eAutomatically place scheduled callbacks instead of requiring an agent to dial them manually.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_machine_detection","full_name":"use_machine_detection","description":"\n\u003cp\u003eUse answering machine detection on outbound calls from this schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_sms_use_ring_pool","full_name":"action_sms_use_ring_pool","description":"\n\u003cp\u003eSend SMS actions from a Ring Pool instead of a single number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_sms_ring_pool_id","full_name":"action_sms_ring_pool_id","description":"\n\u003cp\u003eThe Ring Pool used to send SMS actions when \u003ccode\u003eaction_sms_use_ring_pool\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"action_sms_number_id","full_name":"action_sms_number_id","description":"\n\u003cp\u003eThe number used to send SMS actions when \u003ccode\u003eaction_sms_use_ring_pool\u003c/code\u003e is false.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"contact_caller_permission_required","full_name":"contact_caller_permission_required","description":"\n\u003cp\u003eRequire the lead’s permission before running certain schedule actions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_caller_permission_action_types","full_name":"contact_caller_permission_action_types","description":"\n\u003cp\u003eThe action types that require contact caller permission when \u003ccode\u003econtact_caller_permission_required\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eReject leads submitted to this schedule without a \u003ccode\u003etraffic_source_id\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_traffic_source_reject_duplicates","full_name":"lead_traffic_source_reject_duplicates","description":"\n\u003cp\u003eReject a lead when another lead with the same traffic source already exists on this schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_contact_field_validations","full_name":"enforce_contact_field_validations","description":"\n\u003cp\u003eValidate submitted leads against this schedule’s contact field configuration.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minimum_caller_number_length","full_name":"minimum_caller_number_length","description":"\n\u003cp\u003eReject leads whose phone number has fewer digits than this.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_caller_number_length","full_name":"maximum_caller_number_length","description":"\n\u003cp\u003eReject leads whose phone number has more digits than this.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_duplicate_timeframe_scope","full_name":"lead_duplicate_timeframe_scope","description":"\n\u003cp\u003eWhether \u003ccode\u003elead_duplicate_timeframe\u003c/code\u003e checks for duplicates within this schedule or across the whole company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule_id\u003c/th\u003e\u003ctd\u003eDedupe against leads on this schedule only.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecompany_id\u003c/th\u003e\u003ctd\u003eDedupe against all leads in your account.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_leads_per_remote_ip","full_name":"max_leads_per_remote_ip","description":"\n\u003cp\u003eThe maximum number of leads accepted from the same remote IP within \u003ccode\u003emax_leads_per_remote_ip_interval\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_leads_per_remote_ip_interval","full_name":"max_leads_per_remote_ip_interval","description":"\n\u003cp\u003eThe interval, in seconds, over which \u003ccode\u003emax_leads_per_remote_ip\u003c/code\u003e is enforced.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_do_not_call","full_name":"use_do_not_call","description":"\n\u003cp\u003eReject leads whose number is on the Do Not Call list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_dnc_litigators","full_name":"use_dnc_litigators","description":"\n\u003cp\u003eReject leads whose number belongs to a known DNC litigator.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reject_number_not_in_service","full_name":"reject_number_not_in_service","description":"\n\u003cp\u003eReject leads whose number is not in service.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_suppression_id","full_name":"buyer_suppression_id","description":"\n\u003cp\u003eThe Buyer Suppression list used to suppress leads and callers on this schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"tcpa_shield_enabled","full_name":"tcpa_shield_enabled","description":"\n\u003cp\u003eCheck leads against TCPA Shield before dialing them.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tcpa_shield_integration_id","full_name":"tcpa_shield_integration_id","description":"\n\u003cp\u003eThe TCPA Shield integration used when \u003ccode\u003etcpa_shield_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"blacklist_alliance_enabled","full_name":"blacklist_alliance_enabled","description":"\n\u003cp\u003eCheck leads against Blacklist Alliance before dialing them.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blacklist_alliance_integration_id","full_name":"blacklist_alliance_integration_id","description":"\n\u003cp\u003eThe Blacklist Alliance integration used when \u003ccode\u003eblacklist_alliance_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"daylight_hours_open","full_name":"daylight_hours_open","description":"\n\u003cp\u003eThe time of day, in \u003ccode\u003eHHMM\u003c/code\u003e format using the lead’s local time zone, that daylight hours dialing opens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"daylight_hours_close","full_name":"daylight_hours_close","description":"\n\u003cp\u003eThe time of day, in \u003ccode\u003eHHMM\u003c/code\u003e format using the lead’s local time zone, that daylight hours dialing closes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_hours_open","full_name":"scheduled_callback_hours_open","description":"\n\u003cp\u003eThe time of day, in \u003ccode\u003eHHMM\u003c/code\u003e format using the schedule’s time zone, that scheduled callbacks may start being placed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scheduled_callback_hours_close","full_name":"scheduled_callback_hours_close","description":"\n\u003cp\u003eThe time of day, in \u003ccode\u003eHHMM\u003c/code\u003e format using the schedule’s time zone, that scheduled callbacks stop being placed.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003ePublish this schedule’s posting instructions page. Turning this on requires the company to have completed identity verification.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eList this schedule’s posting instructions page on the company’s public index.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe title shown on this schedule’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe rich-text description shown on this schedule’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_duplicate_timeframe","full_name":"lead_duplicate_timeframe","description":"\n\u003cp\u003eThe period of time, in seconds, that must elapse before the same caller can create another lead on this schedule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedules/:id","http_method":"DELETE","short_description":"Destroy Schedule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eschedule\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eschedule_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"secret_items":{"doc_url":"/api/docs/1.0/secret_items","id":"secret_items","api_url":"/api","name":"Secret","short_description":"Encrypted key-value secrets stored per account for securely referencing sensitive values like API keys in configurations.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/secret_items/index","name":"index","apis":[{"api_url":"/api/v1/secret_items","http_method":"GET","short_description":"List Secret records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_replacement_example\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/secret_items/new","name":"new","apis":[{"api_url":"/api/v1/secret_items/new","http_method":"GET","short_description":"Build Secret with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eThe secret’s value, such as an API key or credential, stored encrypted so it can be referenced elsewhere without exposing it directly.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"change_value","full_name":"change_value","description":"\n\u003cp\u003eSet to true to replace the stored value with the value given in this request; otherwise the existing value is kept.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/secret_items/create","name":"create","apis":[{"api_url":"/api/v1/secret_items","http_method":"POST","short_description":"Create Secret.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eThe secret’s value, such as an API key or credential, stored encrypted so it can be referenced elsewhere without exposing it directly.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"change_value","full_name":"change_value","description":"\n\u003cp\u003eSet to true to replace the stored value with the value given in this request; otherwise the existing value is kept.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/secret_items/show","name":"show","apis":[{"api_url":"/api/v1/secret_items/:id","http_method":"GET","short_description":"Get Secret by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/secret_items/update","name":"update","apis":[{"api_url":"/api/v1/secret_items/:id","http_method":"PUT","short_description":"Update Secret by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eThe secret’s value, such as an API key or credential, stored encrypted so it can be referenced elsewhere without exposing it directly.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"change_value","full_name":"change_value","description":"\n\u003cp\u003eSet to true to replace the stored value with the value given in this request; otherwise the existing value is kept.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/secret_items/destroy","name":"destroy","apis":[{"api_url":"/api/v1/secret_items/:id","http_method":"DELETE","short_description":"Destroy Secret by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"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 \u003ccode\u003etd_secure_token\u003c/code\u003e and \u003ccode\u003etd_uuid\u003c/code\u003e passed in a call's \u003cstrong\u003eSIP headers\u003c/strong\u003e. These endpoints do not require authentication with a \u003ccode\u003eauth_token\u003c/code\u003e","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 by SIP tokens","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate a call with \u003ccode\u003etd_secure_token\u003c/code\u003e and \u003ccode\u003etd_uuid\u003c/code\u003e passed in a call’s \u003cstrong\u003eSIP headers\u003c/strong\u003e.\u003c/p\u003e\n","errors":[],"params":[{"name":"secure_token","full_name":"secure_token","description":"\n\u003cp\u003eThe secure token used to authorize access to an individual object. Must be 40 characters.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/.{40}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eA unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"revenue","full_name":"revenue","description":"\n\u003cp\u003eThe revenue paid out for the call.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_converted","full_name":"buyer_converted","description":"\n\u003cp\u003eDid the buyer convert?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"digits","full_name":"digits","description":"\n\u003cp\u003eDTMF digit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eUpdate the call with this data. \u003ccode\u003e{interest: \u0026#39;kittens\u0026#39;, source: \u0026#39;google\u0026#39;, first_name: \u0026#39;John\u0026#39;, last_name: \u0026#39;Smith\u0026#39;}\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 a call by SIP tokens","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eHang up an ongoing call using a \u003ccode\u003etd_secure_token\u003c/code\u003e and \u003ccode\u003etd_uuid\u003c/code\u003e passed in a call’s \u003cstrong\u003eSIP headers\u003c/strong\u003e.\u003c/p\u003e\n","errors":[],"params":[{"name":"secure_token","full_name":"secure_token","description":"\n\u003cp\u003eThe secure token used to authorize access to an individual object. Must be 40 characters.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/.{40}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eA unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[{"name":"secure_token","full_name":"secure_token","description":"\n\u003cp\u003eThe secure token used to authorize access to an individual object. Must be 40 characters.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/.{40}/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eA unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sip_header_parser_groups":{"doc_url":"/api/docs/1.0/sip_header_parser_groups","id":"sip_header_parser_groups","api_url":"/api","name":"SIP Header Parsing","short_description":"A named set of rules that pull data out of SIP call headers and save it to a lead.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sip_header_parser_groups/index","name":"index","apis":[{"api_url":"/api/v1/sip_header_parser_groups","http_method":"GET","short_description":"List SIP Header Parsing records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsip_header_parser_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsip_header_parsers_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_header_parser_groups/new","name":"new","apis":[{"api_url":"/api/v1/sip_header_parser_groups/new","http_method":"GET","short_description":"Build SIP Header Parsing with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_header_parser_groups/create","name":"create","apis":[{"api_url":"/api/v1/sip_header_parser_groups","http_method":"POST","short_description":"Create SIP Header Parsing.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_header_parser_groups/show","name":"show","apis":[{"api_url":"/api/v1/sip_header_parser_groups/:id","http_method":"GET","short_description":"Get SIP Header Parsing 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_header_parser_groups/update","name":"update","apis":[{"api_url":"/api/v1/sip_header_parser_groups/:id","http_method":"PUT","short_description":"Update SIP Header Parsing by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_header_parser_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sip_header_parser_groups/:id","http_method":"DELETE","short_description":"Destroy SIP Header Parsing by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sip_header_parsers":{"doc_url":"/api/docs/1.0/sip_header_parsers","id":"sip_header_parsers","api_url":"/api","name":"SIP Key","short_description":"A single rule that maps one SIP header to a contact field, extracting its value onto the lead.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sip_header_parsers/index","name":"index","apis":[{"api_url":"/api/v1/sip_header_parsers","http_method":"GET","short_description":"List SIP Key records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsip_header_parser_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsip_header_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_header_parsers/new","name":"new","apis":[{"api_url":"/api/v1/sip_header_parsers/new","http_method":"GET","short_description":"Build SIP Key with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"sip_header_parser_group_id","full_name":"sip_header_parser_group_id","description":"\n\u003cp\u003eSip Header Parser Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sip_header_key","full_name":"sip_header_key","description":"\n\u003cp\u003eSip Header Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_key","full_name":"contact_field_key","description":"\n\u003cp\u003eContact Field Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_header_parsers/create","name":"create","apis":[{"api_url":"/api/v1/sip_header_parsers","http_method":"POST","short_description":"Create SIP Key.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"sip_header_parser_group_id","full_name":"sip_header_parser_group_id","description":"\n\u003cp\u003eSip Header Parser Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sip_header_key","full_name":"sip_header_key","description":"\n\u003cp\u003eSip Header Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_key","full_name":"contact_field_key","description":"\n\u003cp\u003eContact Field Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_header_parsers/show","name":"show","apis":[{"api_url":"/api/v1/sip_header_parsers/:id","http_method":"GET","short_description":"Get SIP Key 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_header_parsers/update","name":"update","apis":[{"api_url":"/api/v1/sip_header_parsers/:id","http_method":"PUT","short_description":"Update SIP Key by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"sip_header_parser_group_id","full_name":"sip_header_parser_group_id","description":"\n\u003cp\u003eSip Header Parser Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sip_header_key","full_name":"sip_header_key","description":"\n\u003cp\u003eSip Header Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_key","full_name":"contact_field_key","description":"\n\u003cp\u003eContact Field Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_header_parsers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sip_header_parsers/:id","http_method":"DELETE","short_description":"Destroy SIP Key by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"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":"Custom SIP headers attached to a buyer, sent on the SIP leg of a call placed to that buyer.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eId\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eBuyer\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eAssign the internal ids for filtering.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eId\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eBuyer\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eAssign the internal ids for filtering.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eId\u003c/p\u003e\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":[],"deprecated":false},{"name":"buyer_id","full_name":"buyer_id","description":"\n\u003cp\u003eBuyer\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eAssign the internal ids for filtering.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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},"sound_files":{"doc_url":"/api/docs/1.0/sound_files","id":"sound_files","api_url":"/api","name":"Playlists: Sound Files","short_description":"An uploaded audio clip used in call flows and playlists, such as a greeting or hold message.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_values_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsound_playlist_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naudio_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eAudio File\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sound_playlist_ids","full_name":"sound_playlist_ids","description":"\n\u003cp\u003eThe Playlists this sound file belongs to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003ePlay this sound file only when the call matches these Tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eAudio File\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sound_playlist_ids","full_name":"sound_playlist_ids","description":"\n\u003cp\u003eThe Playlists this sound file belongs to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003ePlay this sound file only when the call matches these Tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eAudio File\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sound_playlist_ids","full_name":"sound_playlist_ids","description":"\n\u003cp\u003eThe Playlists this sound file belongs to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003ePlay this sound file only when the call matches these Tokens.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"An ordered or shuffled group of audio files played back together, such as hold music or IVR prompts.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\norder_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_predefined_playlist\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npredefined_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsound_file_ids\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_type","full_name":"order_type","description":"\n\u003cp\u003eHow sound files in this playlist are picked for playback. One of \u003ccode\u003esortable_order\u003c/code\u003e, \u003ccode\u003erandom\u003c/code\u003e, or \u003ccode\u003eround_robin\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003esortable_order\u003c/code\u003e, \u003ccode\u003erandom\u003c/code\u003e, \u003ccode\u003eround_robin\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_predefined_playlist","full_name":"use_predefined_playlist","description":"\n\u003cp\u003eWhen true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"predefined_playlist_id","full_name":"predefined_playlist_id","description":"\n\u003cp\u003eThe built-in Trackdrive playlist played when \u003ccode\u003euse_predefined_playlist\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"sound_file_ids","full_name":"sound_file_ids","description":"\n\u003cp\u003eThe Sound Files in this playlist, in playback order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Sound File}[/api/docs/1.0/sound_files/index.html]. Refer to: {/api/docs/1.0/sound_files}[/api/docs/1.0/sound_files/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_type","full_name":"order_type","description":"\n\u003cp\u003eHow sound files in this playlist are picked for playback. One of \u003ccode\u003esortable_order\u003c/code\u003e, \u003ccode\u003erandom\u003c/code\u003e, or \u003ccode\u003eround_robin\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003esortable_order\u003c/code\u003e, \u003ccode\u003erandom\u003c/code\u003e, \u003ccode\u003eround_robin\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_predefined_playlist","full_name":"use_predefined_playlist","description":"\n\u003cp\u003eWhen true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"predefined_playlist_id","full_name":"predefined_playlist_id","description":"\n\u003cp\u003eThe built-in Trackdrive playlist played when \u003ccode\u003euse_predefined_playlist\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"sound_file_ids","full_name":"sound_file_ids","description":"\n\u003cp\u003eThe Sound Files in this playlist, in playback order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Sound File}[/api/docs/1.0/sound_files/index.html]. Refer to: {/api/docs/1.0/sound_files}[/api/docs/1.0/sound_files/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_type","full_name":"order_type","description":"\n\u003cp\u003eHow sound files in this playlist are picked for playback. One of \u003ccode\u003esortable_order\u003c/code\u003e, \u003ccode\u003erandom\u003c/code\u003e, or \u003ccode\u003eround_robin\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003esortable_order\u003c/code\u003e, \u003ccode\u003erandom\u003c/code\u003e, \u003ccode\u003eround_robin\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_predefined_playlist","full_name":"use_predefined_playlist","description":"\n\u003cp\u003eWhen true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"predefined_playlist_id","full_name":"predefined_playlist_id","description":"\n\u003cp\u003eThe built-in Trackdrive playlist played when \u003ccode\u003euse_predefined_playlist\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"sound_file_ids","full_name":"sound_file_ids","description":"\n\u003cp\u003eThe Sound Files in this playlist, in playback order.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Sound File}[/api/docs/1.0/sound_files/index.html]. Refer to: {/api/docs/1.0/sound_files}[/api/docs/1.0/sound_files/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"API Audio Transcriptions","short_description":"Speech-to-text transcripts generated from an audio file you submit directly, independent of any call or lead.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfile_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_flow_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npostback_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndual_channel\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nspeakers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbody\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhighlight_wrapper_open\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhighlight_wrapper_close\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naudio_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_processed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkeywords\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nutterances\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhighlighted_utterances\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndata\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noriginal_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAudio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"postback_url","full_name":"postback_url","description":"\n\u003cp\u003ePostback URL that we will send the following JSON payload to when the transcription is complete: id, highlighted_utterances, keywords, data, body, utterances, file_url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id","full_name":"caller_id","description":"\n\u003cp\u003eCaller ID associated with the audio file, which may be used for addition triggers and actions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dual_channel","full_name":"dual_channel","description":"\n\u003cp\u003eIs the audio file dual channel?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"speakers","full_name":"speakers","description":"\n\u003cp\u003eNumber of people (speakers) in the audio file.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"highlight_wrapper_open","full_name":"highlight_wrapper_open","description":"\n\u003cp\u003eWhen keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"highlight_wrapper_close","full_name":"highlight_wrapper_close","description":"\n\u003cp\u003eWhen keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n\u003cp\u003eTranscription 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.\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer 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.\u003c/p\u003e\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":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eA 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 \u0026gt; Action settings).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eAudio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"postback_url","full_name":"postback_url","description":"\n\u003cp\u003ePostback URL that we will send the following JSON payload to when the transcription is complete: id, highlighted_utterances, keywords, data, body, utterances, file_url\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"caller_id","full_name":"caller_id","description":"\n\u003cp\u003eCaller ID associated with the audio file, which may be used for addition triggers and actions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dual_channel","full_name":"dual_channel","description":"\n\u003cp\u003eIs the audio file dual channel?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"speakers","full_name":"speakers","description":"\n\u003cp\u003eNumber of people (speakers) in the audio file.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"highlight_wrapper_open","full_name":"highlight_wrapper_open","description":"\n\u003cp\u003eWhen keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"highlight_wrapper_close","full_name":"highlight_wrapper_close","description":"\n\u003cp\u003eWhen keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n\u003cp\u003eTranscription 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.\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer 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.\u003c/p\u003e\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":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eA 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 \u0026gt; Action settings).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eCaller ID associated with the audio file, which may be used for addition triggers and actions.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dual_channel","full_name":"dual_channel","description":"\n\u003cp\u003eIs the audio file dual channel?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"speakers","full_name":"speakers","description":"\n\u003cp\u003eNumber of people (speakers) in the audio file.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"highlight_wrapper_open","full_name":"highlight_wrapper_open","description":"\n\u003cp\u003eWhen keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"highlight_wrapper_close","full_name":"highlight_wrapper_close","description":"\n\u003cp\u003eWhen keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\n\u003cp\u003eTranscription 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.\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer 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.\u003c/p\u003e\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":[],"deprecated":false},{"name":"data","full_name":"data","description":"\n\u003cp\u003eA 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 \u0026gt; Action settings).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"original_data","full_name":"original_data","description":"\n\u003cp\u003eThe original data that was provided when the transcription record was created.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keywords","full_name":"keywords","description":"\n\u003cp\u003eKeywords that were found in the audio file.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"utterances","full_name":"utterances","description":"\n\u003cp\u003eUtterances are the spoken words in the audio file, broken down by speaker.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"highlighted_utterances","full_name":"highlighted_utterances","description":"\n\u003cp\u003eHighlighted Utterances are the spoken words in the audio file, broken down by speaker, with keywords highlighted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transcription_processed","full_name":"transcription_processed","description":"\n\u003cp\u003eReturns true if the audio file has been transcribed and keywords have been highlighted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"audio_duration","full_name":"audio_duration","description":"\n\u003cp\u003eThe detected duration of the audio file in seconds.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"body","full_name":"body","description":"\n\u003cp\u003eThe raw transcription text of the audio file.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Call Times","short_description":"Per-state allowed calling hours for each day of the week, used to block outbound calls outside those windows.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstates\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmonday_open_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmonday_close_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntuesday_open_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntuesday_close_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwednesday_open_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwednesday_close_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nthursday_open_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nthursday_close_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfriday_open_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfriday_close_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsaturday_open_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsaturday_close_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsunday_open_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmonday_closed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntuesday_closed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwednesday_closed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nthursday_closed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfriday_closed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsaturday_closed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsunday_closed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsunday_close_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_copy_on_company_create\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_system_template\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_open_at","full_name":"monday_open_at","description":"\n\u003cp\u003eMonday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_close_at","full_name":"monday_close_at","description":"\n\u003cp\u003eMonday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_open_at","full_name":"tuesday_open_at","description":"\n\u003cp\u003eTuesday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_close_at","full_name":"tuesday_close_at","description":"\n\u003cp\u003eTuesday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_open_at","full_name":"wednesday_open_at","description":"\n\u003cp\u003eWednesday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_close_at","full_name":"wednesday_close_at","description":"\n\u003cp\u003eWednesday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_open_at","full_name":"thursday_open_at","description":"\n\u003cp\u003eThursday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_close_at","full_name":"thursday_close_at","description":"\n\u003cp\u003eThursday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_open_at","full_name":"friday_open_at","description":"\n\u003cp\u003eFriday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_close_at","full_name":"friday_close_at","description":"\n\u003cp\u003eFriday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_open_at","full_name":"saturday_open_at","description":"\n\u003cp\u003eSaturday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_close_at","full_name":"saturday_close_at","description":"\n\u003cp\u003eSaturday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_open_at","full_name":"sunday_open_at","description":"\n\u003cp\u003eSunday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_close_at","full_name":"sunday_close_at","description":"\n\u003cp\u003eSunday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_closed","full_name":"monday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Monday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_closed","full_name":"tuesday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Tuesday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_closed","full_name":"wednesday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Wednesday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_closed","full_name":"thursday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Thursday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_closed","full_name":"friday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Friday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_closed","full_name":"saturday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Saturday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_closed","full_name":"sunday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Sunday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_open_at","full_name":"monday_open_at","description":"\n\u003cp\u003eMonday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_close_at","full_name":"monday_close_at","description":"\n\u003cp\u003eMonday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_open_at","full_name":"tuesday_open_at","description":"\n\u003cp\u003eTuesday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_close_at","full_name":"tuesday_close_at","description":"\n\u003cp\u003eTuesday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_open_at","full_name":"wednesday_open_at","description":"\n\u003cp\u003eWednesday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_close_at","full_name":"wednesday_close_at","description":"\n\u003cp\u003eWednesday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_open_at","full_name":"thursday_open_at","description":"\n\u003cp\u003eThursday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_close_at","full_name":"thursday_close_at","description":"\n\u003cp\u003eThursday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_open_at","full_name":"friday_open_at","description":"\n\u003cp\u003eFriday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_close_at","full_name":"friday_close_at","description":"\n\u003cp\u003eFriday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_open_at","full_name":"saturday_open_at","description":"\n\u003cp\u003eSaturday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_close_at","full_name":"saturday_close_at","description":"\n\u003cp\u003eSaturday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_open_at","full_name":"sunday_open_at","description":"\n\u003cp\u003eSunday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_close_at","full_name":"sunday_close_at","description":"\n\u003cp\u003eSunday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_closed","full_name":"monday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Monday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_closed","full_name":"tuesday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Tuesday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_closed","full_name":"wednesday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Wednesday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_closed","full_name":"thursday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Thursday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_closed","full_name":"friday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Friday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_closed","full_name":"saturday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Saturday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_closed","full_name":"sunday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Sunday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_open_at","full_name":"monday_open_at","description":"\n\u003cp\u003eMonday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_close_at","full_name":"monday_close_at","description":"\n\u003cp\u003eMonday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_open_at","full_name":"tuesday_open_at","description":"\n\u003cp\u003eTuesday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_close_at","full_name":"tuesday_close_at","description":"\n\u003cp\u003eTuesday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_open_at","full_name":"wednesday_open_at","description":"\n\u003cp\u003eWednesday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_close_at","full_name":"wednesday_close_at","description":"\n\u003cp\u003eWednesday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_open_at","full_name":"thursday_open_at","description":"\n\u003cp\u003eThursday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_close_at","full_name":"thursday_close_at","description":"\n\u003cp\u003eThursday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_open_at","full_name":"friday_open_at","description":"\n\u003cp\u003eFriday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_close_at","full_name":"friday_close_at","description":"\n\u003cp\u003eFriday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_open_at","full_name":"saturday_open_at","description":"\n\u003cp\u003eSaturday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_close_at","full_name":"saturday_close_at","description":"\n\u003cp\u003eSaturday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_open_at","full_name":"sunday_open_at","description":"\n\u003cp\u003eSunday Open At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_close_at","full_name":"sunday_close_at","description":"\n\u003cp\u003eSunday Close At\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"monday_closed","full_name":"monday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Monday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tuesday_closed","full_name":"tuesday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Tuesday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wednesday_closed","full_name":"wednesday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Wednesday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"thursday_closed","full_name":"thursday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Thursday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"friday_closed","full_name":"friday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Friday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"saturday_closed","full_name":"saturday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Saturday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sunday_closed","full_name":"sunday_closed","description":"\n\u003cp\u003eWhen true, outbound calls to this state are blocked all day Sunday, regardless of the open/close times.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Call Frequency","short_description":"A cap on how many times contacts in specified states can be called within a set time interval.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstates\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_limit_interval\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_limit_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_system_template\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_copy_on_company_create\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_limit_interval","full_name":"call_limit_interval","description":"\n\u003cp\u003eCall Limit Interval\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_limit_limit","full_name":"call_limit_limit","description":"\n\u003cp\u003eCall Limit Limit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_limit_interval","full_name":"call_limit_interval","description":"\n\u003cp\u003eCall Limit Interval\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_limit_limit","full_name":"call_limit_limit","description":"\n\u003cp\u003eCall Limit Limit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_limit_interval","full_name":"call_limit_interval","description":"\n\u003cp\u003eCall Limit Interval\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_limit_limit","full_name":"call_limit_limit","description":"\n\u003cp\u003eCall Limit Limit\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":"Holidays","short_description":"Dates per state on which outbound calling is blocked, such as state-recognized holidays.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstates\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nholiday_dates\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_copy_on_company_create\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_system_template\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"holiday_dates","full_name":"holiday_dates","description":"\n\u003cp\u003eHoliday Dates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"holiday_dates","full_name":"holiday_dates","description":"\n\u003cp\u003eHoliday Dates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eStates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"holiday_dates","full_name":"holiday_dates","description":"\n\u003cp\u003eHoliday Dates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Rules","short_description":"A named bundle of state-level calling rules (hours, frequency caps, holidays) applied company-wide or to specific offers.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrule_scope\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstate_business_hour_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstate_call_limit_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstate_holiday_ids\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eRule Scope\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecompany\u003c/code\u003e, \u003ccode\u003eoffer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_ids","full_name":"offer_ids","description":"\n\u003cp\u003eOffer Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_business_hour_ids","full_name":"state_business_hour_ids","description":"\n\u003cp\u003eState Business Hour Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\n\u003cp\u003eState Call Limit Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\n\u003cp\u003eState Holidays Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eRule Scope\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecompany\u003c/code\u003e, \u003ccode\u003eoffer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_ids","full_name":"offer_ids","description":"\n\u003cp\u003eOffer Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_business_hour_ids","full_name":"state_business_hour_ids","description":"\n\u003cp\u003eState Business Hour Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\n\u003cp\u003eState Call Limit Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\n\u003cp\u003eState Holidays Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eRule Scope\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecompany\u003c/code\u003e, \u003ccode\u003eoffer\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_ids","full_name":"offer_ids","description":"\n\u003cp\u003eOffer Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_business_hour_ids","full_name":"state_business_hour_ids","description":"\n\u003cp\u003eState Business Hour Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\n\u003cp\u003eState Call Limit Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\n\u003cp\u003eState Holidays Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/new","name":"new","apis":[{"api_url":"/api/v1/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":null,"full_description":"","errors":[],"params":[{"name":"target_url","full_name":"target_url","description":"\n\u003cp\u003eThe unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid URL.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"event","full_name":"event","description":"\n\u003cp\u003eThe event that will be triggered. EG: When a new call comes in.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew_call\u003c/code\u003e, \u003ccode\u003ecall_ringing\u003c/code\u003e, \u003ccode\u003ecall_forwarded\u003c/code\u003e, \u003ccode\u003ecall_ended\u003c/code\u003e, \u003ccode\u003ecall_changed\u003c/code\u003e, \u003ccode\u003enew_lead\u003c/code\u003e, \u003ccode\u003elead_ended\u003c/code\u003e, \u003ccode\u003elead_converted\u003c/code\u003e, \u003ccode\u003elead_opted_out\u003c/code\u003e, \u003ccode\u003elead_changed\u003c/code\u003e, \u003ccode\u003eincoming_text_message\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_fields","full_name":"trigger_fields","description":"\n\u003cp\u003eFilter the data returned by the subscription. Only trigger if the object matches the given trigger fields. For example:\u003cbr\u003e \u003ccode\u003e{buyer_converted: true, offer_id: 1}\u003c/code\u003e would only fire the trigger if the call converted and came from offer 1. Acceptable triggers: \u003ccode\u003eschedule_id\u003c/code\u003e \u003ccode\u003etraffic_source_id\u003c/code\u003e \u003ccode\u003eoffer_id\u003c/code\u003e \u003ccode\u003ebuyer_converted\u003c/code\u003e \u003ccode\u003ehas_recording\u003c/code\u003e \u003ccode\u003eeither_converted\u003c/code\u003e \u003ccode\u003ebuyer_id\u003c/code\u003e \u003ccode\u003eoffer_converted\u003c/code\u003e \u003ccode\u003enumber_id\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[{"name":"target_url","full_name":"target_url","description":"\n\u003cp\u003eThe unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid URL.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"event","full_name":"event","description":"\n\u003cp\u003eThe event that will be triggered. EG: When a new call comes in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew_call\u003c/code\u003e, \u003ccode\u003ecall_ringing\u003c/code\u003e, \u003ccode\u003ecall_forwarded\u003c/code\u003e, \u003ccode\u003ecall_ended\u003c/code\u003e, \u003ccode\u003ecall_changed\u003c/code\u003e, \u003ccode\u003enew_lead\u003c/code\u003e, \u003ccode\u003elead_ended\u003c/code\u003e, \u003ccode\u003elead_converted\u003c/code\u003e, \u003ccode\u003elead_opted_out\u003c/code\u003e, \u003ccode\u003elead_changed\u003c/code\u003e, \u003ccode\u003eincoming_text_message\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[{"name":"target_url","full_name":"target_url","description":"\n\u003cp\u003eThe unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"system_logs":{"doc_url":"/api/docs/1.0/system_logs","id":"system_logs","api_url":"/api","name":"Audit Logs","short_description":"An audit log of system-related changes in your Trackdrive account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/system_logs/index","name":"index","apis":[{"api_url":"/api/v1/system_logs","http_method":"GET","short_description":"List System Log records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/system_logs/show","name":"show","apis":[{"api_url":"/api/v1/system_logs/:id","http_method":"GET","short_description":"Get System Log by id.","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 Flows","short_description":"Automates a text message conversation for an offer, parsing replies and sending follow-up responses.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nparse_value_with_expression\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue_formatter\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue_expression\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_flow_when_pattern_matches\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_value_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_a_response\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_message\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_assign_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_field_validate_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_message_flow_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nassert_acceptable_with_contact_field\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_message_when_unacceptable\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nattribution_token_value_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_message_flows_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprocess_response_with_sms_flow_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwait_for_response_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalid_responses_csv\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"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":[],"deprecated":false},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\n\u003cp\u003eParse Value With Expression\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_formatter","full_name":"value_formatter","description":"\n\u003cp\u003eValue Formatter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\n\u003cp\u003eValue Expression\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\n\u003cp\u003eUse Flow When Pattern Matches\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_a_response","full_name":"request_a_response","description":"\n\u003cp\u003eRequest A Response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_message","full_name":"response_message","description":"\n\u003cp\u003eThe outgoing SMS message sent back to the consumer when this flow matches the incoming message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\n\u003cp\u003eAssert Acceptable With Contact Field\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\n\u003cp\u003eResponse Message When Unacceptable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_assign_id","full_name":"contact_field_assign_id","description":"\n\u003cp\u003eThe Contact Field the consumer’s reply is saved to on the lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"contact_field_validate_id","full_name":"contact_field_validate_id","description":"\n\u003cp\u003eThe Contact Field checked against the accepted responses when \u003ccode\u003eassert_acceptable_with_contact_field\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"process_response_with_sms_flow_type","full_name":"process_response_with_sms_flow_type","description":"\n\u003cp\u003eHow the consumer’s reply is passed on for further processing after this flow matches. One of \u003ccode\u003enested_text_message_flows\u003c/code\u003e (try the nested SMS Flows below this one) or \u003ccode\u003eparent_text_message_flows\u003c/code\u003e (pass it to this flow’s parent Offer or SMS Flow).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"valid_responses_csv","full_name":"valid_responses_csv","description":"\n\u003cp\u003eA comma-separated list of the responses accepted as valid when \u003ccode\u003eassert_acceptable_with_contact_field\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_for_response_seconds","full_name":"wait_for_response_seconds","description":"\n\u003cp\u003eHow many seconds Trackdrive waits for the consumer’s reply before giving up on this flow.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_message_flow_id","full_name":"text_message_flow_id","description":"\n\u003cp\u003eThe parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {SMS AI Flow}[/api/docs/1.0/text_message_flows/index.html]. Refer to: {/api/docs/1.0/text_message_flows}[/api/docs/1.0/text_message_flows/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"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":[],"deprecated":false},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\n\u003cp\u003eParse Value With Expression\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_formatter","full_name":"value_formatter","description":"\n\u003cp\u003eValue Formatter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\n\u003cp\u003eValue Expression\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\n\u003cp\u003eUse Flow When Pattern Matches\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_a_response","full_name":"request_a_response","description":"\n\u003cp\u003eRequest A Response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_message","full_name":"response_message","description":"\n\u003cp\u003eThe outgoing SMS message sent back to the consumer when this flow matches the incoming message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\n\u003cp\u003eAssert Acceptable With Contact Field\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\n\u003cp\u003eResponse Message When Unacceptable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_assign_id","full_name":"contact_field_assign_id","description":"\n\u003cp\u003eThe Contact Field the consumer’s reply is saved to on the lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"contact_field_validate_id","full_name":"contact_field_validate_id","description":"\n\u003cp\u003eThe Contact Field checked against the accepted responses when \u003ccode\u003eassert_acceptable_with_contact_field\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"process_response_with_sms_flow_type","full_name":"process_response_with_sms_flow_type","description":"\n\u003cp\u003eHow the consumer’s reply is passed on for further processing after this flow matches. One of \u003ccode\u003enested_text_message_flows\u003c/code\u003e (try the nested SMS Flows below this one) or \u003ccode\u003eparent_text_message_flows\u003c/code\u003e (pass it to this flow’s parent Offer or SMS Flow).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"valid_responses_csv","full_name":"valid_responses_csv","description":"\n\u003cp\u003eA comma-separated list of the responses accepted as valid when \u003ccode\u003eassert_acceptable_with_contact_field\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_for_response_seconds","full_name":"wait_for_response_seconds","description":"\n\u003cp\u003eHow many seconds Trackdrive waits for the consumer’s reply before giving up on this flow.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_message_flow_id","full_name":"text_message_flow_id","description":"\n\u003cp\u003eThe parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {SMS AI Flow}[/api/docs/1.0/text_message_flows/index.html]. Refer to: {/api/docs/1.0/text_message_flows}[/api/docs/1.0/text_message_flows/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOffer\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"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":[],"deprecated":false},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\n\u003cp\u003eParse Value With Expression\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_formatter","full_name":"value_formatter","description":"\n\u003cp\u003eValue Formatter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\n\u003cp\u003eValue Expression\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\n\u003cp\u003eUse Flow When Pattern Matches\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_a_response","full_name":"request_a_response","description":"\n\u003cp\u003eRequest A Response\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_message","full_name":"response_message","description":"\n\u003cp\u003eThe outgoing SMS message sent back to the consumer when this flow matches the incoming message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\n\u003cp\u003eAssert Acceptable With Contact Field\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\n\u003cp\u003eResponse Message When Unacceptable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"contact_field_assign_id","full_name":"contact_field_assign_id","description":"\n\u003cp\u003eThe Contact Field the consumer’s reply is saved to on the lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"contact_field_validate_id","full_name":"contact_field_validate_id","description":"\n\u003cp\u003eThe Contact Field checked against the accepted responses when \u003ccode\u003eassert_acceptable_with_contact_field\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"process_response_with_sms_flow_type","full_name":"process_response_with_sms_flow_type","description":"\n\u003cp\u003eHow the consumer’s reply is passed on for further processing after this flow matches. One of \u003ccode\u003enested_text_message_flows\u003c/code\u003e (try the nested SMS Flows below this one) or \u003ccode\u003eparent_text_message_flows\u003c/code\u003e (pass it to this flow’s parent Offer or SMS Flow).\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"valid_responses_csv","full_name":"valid_responses_csv","description":"\n\u003cp\u003eA comma-separated list of the responses accepted as valid when \u003ccode\u003eassert_acceptable_with_contact_field\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"wait_for_response_seconds","full_name":"wait_for_response_seconds","description":"\n\u003cp\u003eHow many seconds Trackdrive waits for the consumer’s reply before giving up on this flow.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_message_flow_id","full_name":"text_message_flow_id","description":"\n\u003cp\u003eThe parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {SMS AI Flow}[/api/docs/1.0/text_message_flows/index.html]. Refer to: {/api/docs/1.0/text_message_flows}[/api/docs/1.0/text_message_flows/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Outgoing SMS","short_description":"Send a text message","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":"Send a text message","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"from","full_name":"from","description":"\n\u003cp\u003eSending address (+E.164 formatted phone number.) Example: +18665550001\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"to","description":"\n\u003cp\u003eReceiving address (+E.164 formatted phone number.) Example: +18665550001\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_id","full_name":"lead_id","description":"\n\u003cp\u003eOptional. Associate this text message with this lead. The lead’s telephone number will be used as the Receiving address if “to” is not provided.\u003c/p\u003e\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":[],"deprecated":false},{"name":"message","full_name":"message","description":"\n\u003cp\u003eMessage body (i.e., content) as non-empty string. Example: Hello!\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delivery_webhook_url","full_name":"delivery_webhook_url","description":"\n\u003cp\u003eWebhook to call when the message’s status changes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manual","full_name":"manual","description":"\n\u003cp\u003ePass 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.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\n\u003cp\u003eProvide the sending address as an internal Trackdrive telephone number ID.\u003c/p\u003e\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":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eOptional. 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.\u003c/p\u003e\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":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eOptional. Associate this text message with a matching lead on this offer. If no lead currently exists, one will be created on this offer.\u003c/p\u003e\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":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfrom\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nto\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nprovider_configuration_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_uuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndestination_caller_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstatus\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nerror_code\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nring_pool_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsent_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmanual\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontact_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndelivery_webhook_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_message_flow_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_messages/show","name":"show","apis":[{"api_url":"/api/v1/text_messages/:id","http_method":"GET","short_description":"Get a text message request","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":"Advertising Optimizer Tokens","short_description":"Maps an incoming URL parameter name to a tracking token, so posted data lands in the right field.","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\u003cp\u003eFilter for records that belong to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"\n\u003cp\u003eThe ID for the record that owns this record.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_type","full_name":"owner_type","description":"\n\u003cp\u003eThe type of record that owns this record.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nurl_param_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_type\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"\n\u003cp\u003eThe ID for the record that owns this record.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_type","full_name":"owner_type","description":"\n\u003cp\u003eThe type of record that owns this record.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_key","full_name":"token_key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url_param_key","full_name":"url_param_key","description":"\n\u003cp\u003eThis URL key will be assigned to a Trackdrive Token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_id","full_name":"token_id","description":"\n\u003cp\u003eLink directly to an existing Token by its id instead of matching by token name.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"\n\u003cp\u003eThe ID for the record that owns this record.\u003c/p\u003e\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":[],"deprecated":false},{"name":"owner_type","full_name":"owner_type","description":"\n\u003cp\u003eThe type of record that owns this record.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_key","full_name":"token_key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url_param_key","full_name":"url_param_key","description":"\n\u003cp\u003eThis URL key will be assigned to a Trackdrive Token.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_id","full_name":"token_id","description":"\n\u003cp\u003eLink directly to an existing Token by its id instead of matching by token name.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"\n\u003cp\u003eThe ID for the record that owns this record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"owner_type","full_name":"owner_type","description":"\n\u003cp\u003eThe type of record that owns this record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_key","full_name":"token_key","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"url_param_key","full_name":"url_param_key","description":"\n\u003cp\u003eThis URL key will be assigned to a Trackdrive Token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_id","full_name":"token_id","description":"\n\u003cp\u003eLink directly to an existing Token by its id instead of matching by token name.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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_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":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\n\u003cp\u003eFilter by this key.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eFilter by this value.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_id","full_name":"token_id","description":"\n\u003cp\u003eFilter by this token.\u003c/p\u003e\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":[],"deprecated":false},{"name":"operator","full_name":"operator","description":"\n\u003cp\u003eFilter by this operator.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e==\u003c/code\u003e, \u003ccode\u003e!=\u003c/code\u003e, \u003ccode\u003e=~\u003c/code\u003e, \u003ccode\u003e!~\u003c/code\u003e, \u003ccode\u003e\u0026lt;\u003c/code\u003e, \u003ccode\u003e\u0026lt;=\u003c/code\u003e, \u003ccode\u003e\u0026gt;\u003c/code\u003e, \u003ccode\u003e\u0026gt;=\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nis_system_token\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tokens":{"doc_url":"/api/docs/1.0/tokens","id":"tokens","api_url":"/api","name":"Token","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 Tokens.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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 Token by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"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":null,"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 Token by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"color","full_name":"color","description":"\n\u003cp\u003eBackground Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eBackground Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which this token appears in lists and reports. Lower values are shown first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eAn alias for key.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of what this token stores.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_token","full_name":"number_token","description":"\n\u003cp\u003eWhen true, this token only accepts numeric values.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inherit_from_previous_call","full_name":"inherit_from_previous_call","description":"\n\u003cp\u003eCarry this token’s value forward from the caller’s previous call when the current call does not supply one.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_message_enabled","full_name":"call_router_message_enabled","description":"\n\u003cp\u003ePlay an IVR message asking the caller to press a key, and store their key press as this token’s value.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"static_value","full_name":"static_value","description":"\n\u003cp\u003eA fixed value to always use for this token, ignoring any value supplied on the call or lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_static_value","full_name":"use_static_value","description":"\n\u003cp\u003eWhen true, always use static_value for this token instead of the value supplied on the call or lead.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"acceptable_tokens_enabled","full_name":"acceptable_tokens_enabled","description":"\n\u003cp\u003eRestrict this token to a defined list of acceptable values instead of accepting any properly formatted value.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"acceptable_token_list","full_name":"acceptable_token_list","description":"\n\u003cp\u003eComma separated list of the values this token will accept when acceptable_tokens_enabled is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"acceptable_token_value_ids","full_name":"acceptable_token_value_ids","description":"\n\u003cp\u003eThe ids of the existing Token Values this token will accept when acceptable_tokens_enabled is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"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":"List an offer's or schedule's contact fields","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\n\u003cp\u003eThe token that determines where submitted data is routed. Get it from the Offer or Schedule.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"traffic_source_rate_limiters":{"doc_url":"/api/docs/1.0/traffic_source_rate_limiters","id":"traffic_source_rate_limiters","api_url":"/api","name":"Traffic Source Rate Limiters","short_description":"Manage reusable rate limit configurations for traffic sources.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/traffic_source_rate_limiters/index","name":"index","apis":[{"api_url":"/api/v1/traffic_source_rate_limiters","http_method":"GET","short_description":"List all traffic source rate limiters.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_rate_limits_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limiters/new","name":"new","apis":[{"api_url":"/api/v1/traffic_source_rate_limiters/new","http_method":"GET","short_description":"Build a new traffic source rate limiter.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limiters/create","name":"create","apis":[{"api_url":"/api/v1/traffic_source_rate_limiters","http_method":"POST","short_description":"Create a traffic source rate limiter.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limiters/show","name":"show","apis":[{"api_url":"/api/v1/traffic_source_rate_limiters/:id","http_method":"GET","short_description":"Show a traffic source rate limiter.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limiters/update","name":"update","apis":[{"api_url":"/api/v1/traffic_source_rate_limiters/:id","http_method":"PUT","short_description":"Update a traffic source rate limiter.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limiters/destroy","name":"destroy","apis":[{"api_url":"/api/v1/traffic_source_rate_limiters/:id","http_method":"DELETE","short_description":"Delete a traffic source rate limiter.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"traffic_source_rate_limits":{"doc_url":"/api/docs/1.0/traffic_source_rate_limits","id":"traffic_source_rate_limits","api_url":"/api","name":"Traffic Source Rate Limits","short_description":"Manage per-traffic-source rate limit entries.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/traffic_source_rate_limits/index","name":"index","apis":[{"api_url":"/api/v1/traffic_source_rate_limits","http_method":"GET","short_description":"List all traffic source rate limits.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_rate_limiter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_minute\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_hour\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrate_limit_per_day\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_traffic_source_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limits/new","name":"new","apis":[{"api_url":"/api/v1/traffic_source_rate_limits/new","http_method":"GET","short_description":"Build a new traffic source rate limit.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"traffic_source_rate_limiter_id","full_name":"traffic_source_rate_limiter_id","description":"\n\u003cp\u003eThe parent rate limiter group ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source ID.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limits/create","name":"create","apis":[{"api_url":"/api/v1/traffic_source_rate_limits","http_method":"POST","short_description":"Create a traffic source rate limit.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"traffic_source_rate_limiter_id","full_name":"traffic_source_rate_limiter_id","description":"\n\u003cp\u003eThe parent rate limiter group ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source ID.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_minute","full_name":"rate_limit_per_minute","description":"\n\u003cp\u003eMaximum pings per minute for this traffic source.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_hour","full_name":"rate_limit_per_hour","description":"\n\u003cp\u003eMaximum pings per hour for this traffic source.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_day","full_name":"rate_limit_per_day","description":"\n\u003cp\u003eMaximum pings per day for this traffic source.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limits/show","name":"show","apis":[{"api_url":"/api/v1/traffic_source_rate_limits/:id","http_method":"GET","short_description":"Show a traffic source rate limit.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limits/update","name":"update","apis":[{"api_url":"/api/v1/traffic_source_rate_limits/:id","http_method":"PUT","short_description":"Update a traffic source rate limit.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"traffic_source_rate_limiter_id","full_name":"traffic_source_rate_limiter_id","description":"\n\u003cp\u003eThe parent rate limiter group ID.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eThe traffic source ID.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_minute","full_name":"rate_limit_per_minute","description":"\n\u003cp\u003eMaximum pings per minute for this traffic source.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_hour","full_name":"rate_limit_per_hour","description":"\n\u003cp\u003eMaximum pings per hour for this traffic source.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_limit_per_day","full_name":"rate_limit_per_day","description":"\n\u003cp\u003eMaximum pings per day for this traffic source.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_source_rate_limits/destroy","name":"destroy","apis":[{"api_url":"/api/v1/traffic_source_rate_limits/:id","http_method":"DELETE","short_description":"Delete a traffic source rate limit.","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":"The traffic sources in your account.","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":"Get traffic sources matching filters.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003eupdated_at\u003c/code\u003e, \u003ccode\u003efirst_name\u003c/code\u003e, \u003ccode\u003elast_name\u003c/code\u003e, \u003ccode\u003ecompany_name\u003c/code\u003e, \u003ccode\u003enumbers_count\u003c/code\u003e, \u003ccode\u003erecent_calls_count\u003c/code\u003e, \u003ccode\u003elast_call_at\u003c/code\u003e, \u003ccode\u003ecalls_count\u003c/code\u003e, \u003ccode\u003euser_traffic_source_id\u003c/code\u003e, \u003ccode\u003enumber_limit\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_traffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfirst_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_call_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncalls_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecent_calls_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_description\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_tier\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntemplate_copy_on_company_create\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nteam_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_sources/new","name":"new","apis":[{"api_url":"/api/v1/traffic_sources/new","http_method":"GET","short_description":"Build Traffic Source with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"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":null,"full_description":"","errors":[],"params":[{"name":"user_traffic_source_id","full_name":"user_traffic_source_id","description":"\n\u003cp\u003eYour own unique identifier for the Traffic Source, also known as an AFID.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"first_name","full_name":"first_name","description":"\n\u003cp\u003eThe first name for the Traffic Source’s contact.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eThe last name for the Traffic Source’s contact.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_name","full_name":"company_name","description":"\n\u003cp\u003eThe company name for the Traffic Source’s contact.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA free-text note about this Traffic Source, stored alongside it and returned in the API response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_limit","full_name":"number_limit","description":"\n\u003cp\u003eHow many numbers can team members purchase for this Traffic Source?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\n\u003cp\u003eGive this Traffic Source access to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"revoke_team_offer_id","full_name":"revoke_team_offer_id","description":"\n\u003cp\u003eRemove access to this Offer for this Traffic Source.\u003c/p\u003e\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":[],"deprecated":false},{"name":"generate_team","full_name":"generate_team","description":"\n\u003cp\u003eGrant access to this Traffic Source, and calls that it publishes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n\u003cp\u003eThe selected users will receive an email invitation to collaborate on your company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: \u003ccode\u003e[\"john-smith@gmail.com\", \"example@domain.com\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n\u003cp\u003eTeam members will be able to buy numbers for these offers, and view calls published to them by their Traffic Source.\u003c/p\u003e\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":[],"deprecated":false}],"returns":[],"examples":[],"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":null,"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":null,"full_description":"","errors":[],"params":[{"name":"user_traffic_source_id","full_name":"user_traffic_source_id","description":"\n\u003cp\u003eYour own unique identifier for the Traffic Source, also known as an AFID.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"first_name","full_name":"first_name","description":"\n\u003cp\u003eThe first name for the Traffic Source’s contact.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eThe last name for the Traffic Source’s contact.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"company_name","full_name":"company_name","description":"\n\u003cp\u003eThe company name for the Traffic Source’s contact.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA free-text note about this Traffic Source, stored alongside it and returned in the API response.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_limit","full_name":"number_limit","description":"\n\u003cp\u003eHow many numbers can team members purchase for this Traffic Source?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\n\u003cp\u003eGive this Traffic Source access to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"revoke_team_offer_id","full_name":"revoke_team_offer_id","description":"\n\u003cp\u003eRemove access to this Offer for this Traffic Source.\u003c/p\u003e\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":[],"deprecated":false},{"name":"generate_team","full_name":"generate_team","description":"\n\u003cp\u003eGrant access to this Traffic Source, and calls that it publishes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_users_emails","full_name":"team_users_emails","description":"\n\u003cp\u003eThe selected users will receive an email invitation to collaborate on your company.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG: \u003ccode\u003e[\"john-smith@gmail.com\", \"example@domain.com\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\n\u003cp\u003eTeam members will be able to buy numbers for these offers, and view calls published to them by their Traffic Source.\u003c/p\u003e\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":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"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 Groups","short_description":"A named group for organizing related transcription flow configurations.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_flows_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Flows","short_description":"Configures which calls get automatically transcribed, based on the recording type (the full call, the consumer-agent leg, or the consumer-buyer leg) and an optional filter, such as call direction or the caller's location.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_flow_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecording_types\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_keyword_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_action_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nredact_pii\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nredact_pii_audio\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nredact_pii_sub\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nredact_pii_types\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenable_summary\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenable_sentiment\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenable_topics\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenable_entities\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenable_highlights\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenable_language_detection\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nai_feature_rates\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_base_rate\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eTranscription Flow Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recording_types","full_name":"recording_types","description":"\n\u003cp\u003eRecording Types\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transcription_keyword_group_id","full_name":"transcription_keyword_group_id","description":"\n\u003cp\u003eThe Transcription Keyword Group scanned for in this flow’s transcripts, if any.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Transcription Keyword Group}[/api/docs/1.0/transcription_keyword_groups/index.html]. Refer to: {/api/docs/1.0/transcription_keyword_groups}[/api/docs/1.0/transcription_keyword_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\n\u003cp\u003eRun this Schedule Action Group against the call after its transcript is ready.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule Action Group}[/api/docs/1.0/schedule_action_groups/index.html]. Refer to: {/api/docs/1.0/schedule_action_groups}[/api/docs/1.0/schedule_action_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eTranscription Flow Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recording_types","full_name":"recording_types","description":"\n\u003cp\u003eRecording Types\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transcription_keyword_group_id","full_name":"transcription_keyword_group_id","description":"\n\u003cp\u003eThe Transcription Keyword Group scanned for in this flow’s transcripts, if any.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Transcription Keyword Group}[/api/docs/1.0/transcription_keyword_groups/index.html]. Refer to: {/api/docs/1.0/transcription_keyword_groups}[/api/docs/1.0/transcription_keyword_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\n\u003cp\u003eRun this Schedule Action Group against the call after its transcript is ready.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule Action Group}[/api/docs/1.0/schedule_action_groups/index.html]. Refer to: {/api/docs/1.0/schedule_action_groups}[/api/docs/1.0/schedule_action_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eTranscription Flow Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"recording_types","full_name":"recording_types","description":"\n\u003cp\u003eRecording Types\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\n\u003cp\u003eRecord Token Filter\u003c/p\u003e\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":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eToken Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transcription_keyword_group_id","full_name":"transcription_keyword_group_id","description":"\n\u003cp\u003eThe Transcription Keyword Group scanned for in this flow’s transcripts, if any.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Transcription Keyword Group}[/api/docs/1.0/transcription_keyword_groups/index.html]. Refer to: {/api/docs/1.0/transcription_keyword_groups}[/api/docs/1.0/transcription_keyword_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\n\u003cp\u003eRun this Schedule Action Group against the call after its transcript is ready.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Schedule Action Group}[/api/docs/1.0/schedule_action_groups/index.html]. Refer to: {/api/docs/1.0/schedule_action_groups}[/api/docs/1.0/schedule_action_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Transcription Keyword Groups","short_description":"A named group of keywords that Trackdrive spots within call transcriptions to flag calls automatically.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Defines keywords or phrases to detect in call transcripts, and which audio channel to scan.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_keyword_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndetection_channel\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkeywords\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eTranscription Keyword Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"detection_channel","full_name":"detection_channel","description":"\n\u003cp\u003eDetection Channel\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecaller\u003c/code\u003e, \u003ccode\u003eothers\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"values","full_name":"values","description":"\n\u003cp\u003eValues\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keywords","full_name":"keywords","description":"\n\u003cp\u003eKeywords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA note describing what this Transcription Keyword detects, shown when managing your keywords.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eTranscription Keyword Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"detection_channel","full_name":"detection_channel","description":"\n\u003cp\u003eDetection Channel\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecaller\u003c/code\u003e, \u003ccode\u003eothers\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"values","full_name":"values","description":"\n\u003cp\u003eValues\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keywords","full_name":"keywords","description":"\n\u003cp\u003eKeywords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA note describing what this Transcription Keyword detects, shown when managing your keywords.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eTranscription Keyword Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"detection_channel","full_name":"detection_channel","description":"\n\u003cp\u003eDetection Channel\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecaller\u003c/code\u003e, \u003ccode\u003eothers\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"values","full_name":"values","description":"\n\u003cp\u003eValues\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\n\u003cp\u003eAttribution Token Value Ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"keywords","full_name":"keywords","description":"\n\u003cp\u003eKeywords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG: \u003ccode\u003e[\"abc123\", \"xzy023\"]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA note describing what this Transcription Keyword detects, shown when managing your keywords.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"Transcripts","short_description":"A text transcript of a call's audio, including its duration, per-speaker utterances, and any matched keywords.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_id","full_name":"call_id","description":"\n\u003cp\u003eThe internal id for a call on Trackdrive.\u003c/p\u003e\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":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfile_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_flow_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkeywords\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecording_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naudio_duration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhighlighted_utterances\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nutterances\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntranscription_processed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsummary\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagent_talk_percent\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nconsumer_talk_percent\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsentiment\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntopics\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntopic_labels\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nentities\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlanguage_code\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncharge_amount\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nredact_pii\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfrom\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nto\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndirection\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsucceeded_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nblocked_at_from\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nblocked_at_to\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_ip\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlast_contact_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nunblock_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked_at_from","full_name":"blocked_at_from","description":"\n\u003cp\u003eBlocked At From\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:25 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked_at_to","full_name":"blocked_at_to","description":"\n\u003cp\u003eBlocked At To\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:25 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_ip","full_name":"request_ip","description":"\n\u003cp\u003eRequest Ip\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_contact_id","full_name":"last_contact_id","description":"\n\u003cp\u003eLast Contact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked_at_from","full_name":"blocked_at_from","description":"\n\u003cp\u003eBlocked At From\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:25 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked_at_to","full_name":"blocked_at_to","description":"\n\u003cp\u003eBlocked At To\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 10:23:25 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_ip","full_name":"request_ip","description":"\n\u003cp\u003eRequest Ip\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_contact_id","full_name":"last_contact_id","description":"\n\u003cp\u003eLast Contact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"A log of inbound calls that were rejected or failed to connect, with the reason why.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndirection\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfrom_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nto_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhuman_reject_reason\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nreject_reason\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"virtual_numbers":{"doc_url":"/api/docs/1.0/virtual_numbers","id":"virtual_numbers","api_url":"/api","name":"Virtual Numbers","short_description":"A SIP-based number that routes calls to an offer without using a real telephone line.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumber\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrackdrive_number_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eNumber\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eNumber\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eRefer to the offer api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\n\u003cp\u003eRefer to the Number Pool api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\n\u003cp\u003eRefer to the traffic source api for details\u003c/p\u003e\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":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eTranslation missing: en.api.description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"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\u003cp\u003eFilter for records that belong to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eThis URL key will be assigned to a Trackdrive Token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\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":[],"deprecated":false},{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eThis URL key will be assigned to a Trackdrive Token.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe internal token name where values are stored.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eThis URL key will be assigned to a Trackdrive Token.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\n\u003cp\u003eThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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":"Webhook 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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results. A per_page request parameter \u0026gt; 10 is not allowed, cursor must be used instead.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cursor","full_name":"cursor","description":"\n\u003cp\u003eThe API provides a technique called ‘cursoring’ 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 \u003cstrong\u003emetadata.next_cursor\u003c/strong\u003e. 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nowner_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncode\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_body\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_url_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_method\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntraffic_source_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_headers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_headers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequest_body\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nduration\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntrackdrive_notes\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nread_from_cache\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_parsers\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzoho_crm_command_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_disposition_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_created_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncaller_number\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsource_ip\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nping_before_calling\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_uuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninbound_webhook_id\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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_params":{"doc_url":"/api/docs/1.0/webhook_params","id":"webhook_params","api_url":"/api","name":"Webhook Param","short_description":"A custom key and value pair appended to an outgoing webhook request, often filled with token data.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvalue\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_url_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_conversion_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_control_action_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninbound_webhook_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzoho_crm_command_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eOutgoing Webhook Url\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n\u003cp\u003eThe Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_control_action_id","full_name":"call_control_action_id","description":"\n\u003cp\u003eThe Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Call Control Action}[/api/docs/1.0/call_control_actions/index.html]. Refer to: {/api/docs/1.0/call_control_actions}[/api/docs/1.0/call_control_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_webhook_id","full_name":"inbound_webhook_id","description":"\n\u003cp\u003eThe Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Incoming Webhook}[/api/docs/1.0/inbound_webhooks/index.html]. Refer to: {/api/docs/1.0/inbound_webhooks}[/api/docs/1.0/inbound_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zoho_crm_command_id","full_name":"zoho_crm_command_id","description":"\n\u003cp\u003eThe Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Zoho Crm Command}[/api/docs/1.0/zoho_crm_commands/index.html]. Refer to: {/api/docs/1.0/zoho_crm_commands}[/api/docs/1.0/zoho_crm_commands/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eThe Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eOutgoing Webhook Url\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n\u003cp\u003eThe Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_control_action_id","full_name":"call_control_action_id","description":"\n\u003cp\u003eThe Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Call Control Action}[/api/docs/1.0/call_control_actions/index.html]. Refer to: {/api/docs/1.0/call_control_actions}[/api/docs/1.0/call_control_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_webhook_id","full_name":"inbound_webhook_id","description":"\n\u003cp\u003eThe Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Incoming Webhook}[/api/docs/1.0/inbound_webhooks/index.html]. Refer to: {/api/docs/1.0/inbound_webhooks}[/api/docs/1.0/inbound_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zoho_crm_command_id","full_name":"zoho_crm_command_id","description":"\n\u003cp\u003eThe Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Zoho Crm Command}[/api/docs/1.0/zoho_crm_commands/index.html]. Refer to: {/api/docs/1.0/zoho_crm_commands}[/api/docs/1.0/zoho_crm_commands/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eThe Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eOutgoing Webhook Url\u003c/p\u003e\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":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value","full_name":"value","description":"\n\u003cp\u003eValue\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\n\u003cp\u003eThe Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false},{"name":"call_control_action_id","full_name":"call_control_action_id","description":"\n\u003cp\u003eThe Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Call Control Action}[/api/docs/1.0/call_control_actions/index.html]. Refer to: {/api/docs/1.0/call_control_actions}[/api/docs/1.0/call_control_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_webhook_id","full_name":"inbound_webhook_id","description":"\n\u003cp\u003eThe Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Incoming Webhook}[/api/docs/1.0/inbound_webhooks/index.html]. Refer to: {/api/docs/1.0/inbound_webhooks}[/api/docs/1.0/inbound_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zoho_crm_command_id","full_name":"zoho_crm_command_id","description":"\n\u003cp\u003eThe Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Zoho Crm Command}[/api/docs/1.0/zoho_crm_commands/index.html]. Refer to: {/api/docs/1.0/zoho_crm_commands}[/api/docs/1.0/zoho_crm_commands/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\n\u003cp\u003eThe Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Token Value}[/api/docs/1.0/token_values/index.html]. Refer to: {/api/docs/1.0/token_values}[/api/docs/1.0/token_values/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 List Files","short_description":"A CSV file of zip codes imported to populate or update a Zip Code List.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzip_code_list_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nimport_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzip_codes\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzip_codes_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstarted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstopped_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsucceeded_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfailed_at\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eZip Code List\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eImport File\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eZip Code List\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eImport File\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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 Codes","short_description":"A named, reusable list of zip codes used to include or exclude leads by location in filters.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzip_code_list_file_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzip_codes_count\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eA CSV file of zip codes to add to this list. Required when creating a list; uploading again on update adds more zip codes to the existing list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eA CSV file of zip codes to add to this list. Required when creating a list; uploading again on update adds more zip codes to the existing list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file","full_name":"import_file","description":"\n\u003cp\u003eA CSV file of zip codes to add to this list. Required when creating a list; uploading again on update adds more zip codes to the existing list.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"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":"An automated action that syncs lead or call data to Zoho CRM, such as creating or updating a record.","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\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_action_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmodule_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmodule_primary_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntoken_value_map_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_params_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nresponse_parsers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nzoho_parent_type\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/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\u003cp\u003eSchedule Action\u003c/p\u003e\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":[],"deprecated":false},{"name":"action_type","full_name":"action_type","description":"\n\u003cp\u003eAction Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"module_type","full_name":"module_type","description":"\n\u003cp\u003eModule Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"module_primary_key","full_name":"module_primary_key","description":"\n\u003cp\u003eModule Primary Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zoho_parent_type","full_name":"zoho_parent_type","description":"\n\u003cp\u003eThe Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead and call data to custom values by assigning these Token Value Map Groups to this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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\u003cp\u003eSchedule Action\u003c/p\u003e\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":[],"deprecated":false},{"name":"action_type","full_name":"action_type","description":"\n\u003cp\u003eAction Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"module_type","full_name":"module_type","description":"\n\u003cp\u003eModule Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"module_primary_key","full_name":"module_primary_key","description":"\n\u003cp\u003eModule Primary Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zoho_parent_type","full_name":"zoho_parent_type","description":"\n\u003cp\u003eThe Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead and call data to custom values by assigning these Token Value Map Groups to this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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\u003cp\u003eSchedule Action\u003c/p\u003e\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":[],"deprecated":false},{"name":"action_type","full_name":"action_type","description":"\n\u003cp\u003eAction Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"module_type","full_name":"module_type","description":"\n\u003cp\u003eModule Type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"module_primary_key","full_name":"module_primary_key","description":"\n\u003cp\u003eModule Primary Key\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zoho_parent_type","full_name":"zoho_parent_type","description":"\n\u003cp\u003eThe Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\n\u003cp\u003eMap lead and call data to custom values by assigning these Token Value Map Groups to this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":[],"deprecated":false}],"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}}}}