Trackdrive API Reference
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Content
\n","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":"\nAgent Status
\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":"\nContent
\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":"\nAgent Status
\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":"\nAgents
\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":"\nBuyer Groups
\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":"\nCall Centers
\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":"\nContent
\n","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":"\nAgent Status
\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":"\nAgents
\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":"\nBuyer Groups
\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":"\nCall Centers
\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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Sort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","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":"\nThe name of the buyer fleet.
\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":"\nA description for this buyer fleet.
\n","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":"\nA unique identifier for this fleet. Only lowercase letters, numbers, and underscores are allowed. This ID is used in system tokens to identify fleet membership.
\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":"\nThe name of the buyer fleet.
\n","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":"\nA description for this buyer fleet.
\n","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":"\nA unique identifier for this fleet. Only lowercase letters, numbers, and underscores are allowed. This ID is used in system tokens to identify fleet membership.
\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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Sort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:name, maxed_out, weight, tier, cap_reset_at, time_zone, created_at, updated_at, paused, paused_at, paused_by_user_id, unpaused_at, user_updated_at, dial_buyers_type, call_limits.in_progress_count, call_limits.in_progress_used, call_limits.revenue_hourly_used, call_limits.revenue_daily_used, call_limits.revenue_monthly_used, call_limits.revenue_total_used, call_limits.earned_revenue_hourly_used, call_limits.earned_revenue_daily_used, call_limits.earned_revenue_monthly_used, call_limits.earned_revenue_total_used, call_limits.buyer_conversion_hourly_used, call_limits.buyer_conversion_daily_used, call_limits.buyer_conversion_monthly_used, call_limits.buyer_conversion_total_used, call_limits.connection_hourly_used, call_limits.connection_daily_used, call_limits.connection_monthly_used, call_limits.connection_total_used, call_limits.attempt_hourly_used, call_limits.attempt_daily_used, call_limits.attempt_monthly_used, call_limits.attempt_total_used.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\nSort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","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":"\nThe name of the buyer group.
\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":"\nPause or unpause.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nSend true to reset the total caps on this buyer group.
Configure the dial buyer behaviour.
sequentially will dial one buyer a time.
simultaneously will dial all buyers in the group at the same time.
sequentially, simultaneously.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\nThe list of buyer ids that will be dialed.
Example: [100123, 100124, 1000125] Obtain internal buyer IDs by making a request to /api/v1/buyers?columns=name,id,user_buyer_id
Append buyers to this record.
For example pass: [100123,100124] in order to append 100123, and 100124 to the list of buyers in the record.
<strong>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.</strong>
Remove buyers from the record.
For example pass: [100123] in order to delete 100123 from the list of buyers in the record.
Append buyers to the record using the buyer field user_buyer_id
For example pass: ["loan-22-en", "loan-23-fr"]
[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\nRemove buyers from the record using buyer field user_buyer_id
For example pass: ["loan-23-fr"]
[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\nWhen dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).
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.
When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
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.
Date ranges will be parsed using this time zone.
\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":"\nThe maximum number of simultaneous calls this buyer group can receive.
\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":"\nYour own identifier for this buyer group, used to correlate it with a record in an external system.
\n","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":"\nGrant access to manage this buyer group, it’s buyers, and to view calls that it’s paid for.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe selected users will recieve an email invitation to collaborate on your company.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG:[\"john-smith@gmail.com\", \"example@domain.com\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\nTeam members can view calls made to these Offers that were paid for by the buyers in this group.
\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":"\nThe selected teams will be granted access to the buyers in this group.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\nGive this Buyer Group’s teams access to this Offer.
\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":"\nRemove access to this Offer for this Buyer Group’s teams.
\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":"\nAttempt caps limit the number of times a buyer can be attempted in a given interval.
\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":"\nMonthly Attempt Cap
\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":"\nDaily Attempt Cap
\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":"\nHourly Attempt Cap
\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":"\nConnection caps limit the number of times a buyer can be connected in a given interval.
\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":"\nMonthly Connection Cap
\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":"\nDaily Connection Cap
\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":"\nHourly Connection Cap
\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":"\nConversion caps limit the number of times a buyer can convert in a given interval.
\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":"\nMonthly Conversion Cap
\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":"\nDaily Conversion Cap
\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":"\nHourly Conversion Cap
\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":"\nRevenue caps limit the dollar amount that can be paid by a buyer in a given interval.
\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":"\nMonthly $ Revenue Cap
\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":"\nDaily $ Revenue Cap
\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":"\nHourly $ Revenue Cap
\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":"\nPause or unpause.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe name of the buyer group.
\n","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":"\nSend true to reset the total caps on this buyer group.
Configure the dial buyer behaviour.
sequentially will dial one buyer a time.
simultaneously will dial all buyers in the group at the same time.
sequentially, simultaneously.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\nAppend buyers to this record.
For example pass: [100123,100124] in order to append 100123, and 100124 to the list of buyers in the record.
<strong>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.</strong>
Remove buyers from the record.
For example pass: [100123] in order to delete 100123 from the list of buyers in the record.
Append buyers to the record using the buyer field user_buyer_id
For example pass: ["loan-22-en", "loan-23-fr"]
[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\nRemove buyers from the record using buyer field user_buyer_id
For example pass: ["loan-23-fr"]
[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\nThe list of buyer ids that will be dialed.
Example: [100123, 100124, 1000125] Obtain internal buyer IDs by making a request to /api/v1/buyers?columns=name,id,user_buyer_id
When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).
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.
When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
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.
Date ranges will be parsed using this time zone.
\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":"\nThe maximum number of simultaneous calls this buyer group can receive.
\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":"\nYour own identifier for this buyer group, used to correlate it with a record in an external system.
\n","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":"\nGrant access to manage this buyer group, it’s buyers, and to view calls that it’s paid for.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe selected users will recieve an email invitation to collaborate on your company.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG:[\"john-smith@gmail.com\", \"example@domain.com\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\nTeam members can view calls made to these Offers that were paid for by the buyers in this group.
\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":"\nThe selected teams will be granted access to the buyers in this group.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\nGive this Buyer Group’s teams access to this Offer.
\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":"\nRemove access to this Offer for this Buyer Group’s teams.
\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":"\nAttempt caps limit the number of times a buyer can be attempted in a given interval.
\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":"\nMonthly Attempt Cap
\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":"\nDaily Attempt Cap
\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":"\nHourly Attempt Cap
\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":"\nConnection caps limit the number of times a buyer can be connected in a given interval.
\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":"\nMonthly Connection Cap
\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":"\nDaily Connection Cap
\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":"\nHourly Connection Cap
\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":"\nConversion caps limit the number of times a buyer can convert in a given interval.
\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":"\nMonthly Conversion Cap
\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":"\nDaily Conversion Cap
\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":"\nHourly Conversion Cap
\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":"\nRevenue caps limit the dollar amount that can be paid by a buyer in a given interval.
\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":"\nMonthly $ Revenue Cap
\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":"\nDaily $ Revenue Cap
\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":"\nHourly $ Revenue Cap
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nBuyer Suppression
\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":"\nApply Block Or Unblock
\n","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":"\nImport File
\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":"\nCaller Id Column Name
\n","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":"\nThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","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":"\nName
\n","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":"\nBuyer Suppression
\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":"\nApply Block Or Unblock
\n","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":"\nImport File
\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":"\nCaller Id Column Name
\n","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":"\nThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","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":"\nName
\n","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":"\nBuyer Suppression
\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":"\nApply Block Or Unblock
\n","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":"\nImport File
\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":"\nCaller Id Column Name
\n","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":"\nThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nCaller Id Column Name
\n","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":"\nThe list of internal buyer ID’s that will use this suppression list.
\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":"\nName
\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":"\nImport File
\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":"\nCaller Id Column Name
\n","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":"\nThe list of internal buyer ID’s that will use this suppression list.
\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":"\nThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\nAppend buyers to this record.
For example pass: [100123,100124] in order to append 100123, and 100124 to the list of buyers in the record.
<strong>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.</strong>
Remove buyers from the record.
For example pass: [100123] in order to delete 100123 from the list of buyers in the record.
Append buyers to the record using the buyer field user_buyer_id
For example pass: ["loan-22-en", "loan-23-fr"]
[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\nRemove buyers from the record using buyer field user_buyer_id
For example pass: ["loan-23-fr"]
[\"abc123\", \"xzy023\"]","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":"\nName
\n","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":"\nCaller Id Column Name
\n","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":"\nThe list of internal buyer ID’s that will use this suppression list.
\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":"\nThe column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"add_buyer_ids","full_name":"add_buyer_ids","description":"\nAppend buyers to this record.
For example pass: [100123,100124] in order to append 100123, and 100124 to the list of buyers in the record.
<strong>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.</strong>
Remove buyers from the record.
For example pass: [100123] in order to delete 100123 from the list of buyers in the record.
Append buyers to the record using the buyer field user_buyer_id
For example pass: ["loan-22-en", "loan-23-fr"]
[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_user_buyer_ids","full_name":"remove_user_buyer_ids","description":"\nRemove buyers from the record using buyer field user_buyer_id
For example pass: ["loan-23-fr"]
[\"abc123\", \"xzy023\"]","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":"\nAn array of phone numbers to block.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","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":"\nAn array of phone numbers to block.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| buyer | Default response format. |
| buyer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Filter buyers for a telephone number.
\n","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":"\nFilter buyers that are either paused or unpaused.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Sort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:id, name, calls_count, recent_calls_count, outgoing_webhooks_count, paused, number, created_at, last_call_at, tier, weight, time_zone, user_buyer_id, revenue_hourly_used, revenue_daily_used, revenue_monthly_used, revenue_total_used, earned_revenue_hourly_used, earned_revenue_daily_used, earned_revenue_monthly_used, earned_revenue_total_used, buyer_conversion_hourly_used, buyer_conversion_daily_used, buyer_conversion_monthly_used, buyer_conversion_total_used, connection_hourly_used, connection_daily_used, connection_monthly_used, connection_total_used, attempt_hourly_used, attempt_daily_used, attempt_monthly_used, attempt_total_used.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\nSort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| buyer | Default response format. |
| buyer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| buyer | Default response format. |
| buyer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| buyer | Default response format. |
| buyer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Your external ID for this buyer.
\n","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":"\nThe 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:’.
\n","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":"\nThe name for this buyer that will appear on menus and in logs.
\n","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":"\nDetermines 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.
\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":"\nPlay 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.
\n","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":"\nThe caller name announced to this buyer when the call connects, with tokens replaced before it is sent.
\n","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":"\nThe number of seconds Trackdrive waits before dialing this buyer after a call is ready to transfer.
\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":"\nDate ranges will be parsed using this time zone.
\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":"\nThe SIP username used when dialing this buyer’s sip: endpoint.
The SIP password used when dialing this buyer’s sip: endpoint.
The known third-party platform this buyer’s number or SIP endpoint belongs to.
\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":"\nThe BuyerFleet this buyer is grouped under.
The list of internal suppression id’s that will be assigned to this buyer.
\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":"\nCallers will be routed to Buyers with matching tokens.
\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":"\nWhen this Buyer is connected to a Caller, the Call will be tagged with these tokens.
\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":"\nPause or unpause the buyer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nEnable or Disable call recordings for this Buyer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nRequire a Trackdrive user logged into your company to have permission to download call recordings for calls transferred to this buyer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAfter answering the call the Buyer must Press 1 before being connected to the Caller.
Trackdrive will use the “Press 1 To Accept” call routing from the current Offer.
Grant access to edit this Buyer, and view calls that it paid for.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe selected users will recieve an email invitation to collaborate on your company.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG:[\"john-smith@gmail.com\", \"example@domain.com\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\nTeam members can view calls made to these Offers that were paid for by their Buyer.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"route_by_type","full_name":"route_by_type","description":"\nConfigure 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.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:tier, revenue, epc.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\nWhen 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.
\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":"\nThe number of hours used when calculating the EPC. If there are less than Minimum Required Calls in this timeframe the Assumed EPC will be used instead.
The Assumed EPC will be used until the Buyer has received Minimum Required Calls calls during the EPC Timeframe.
The number of calls required during EPC Timeframe before the real EPC is used insead of the Assumed EPC.
The Weight of this buyer will be divided by the Total Weight of all buyers at this same Tier to get the % of calls this buyer will get within this Tier.
\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":"\nInclude this buyer when Trackdrive searches for a matching buyer before a lead is matched to an offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nPing this buyer before calling the lead back, used with off-hook webhook conversions.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe order this buyer is pinged in relative to other webhook buyers on the same offer. Lower numbers are pinged first.
\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":"\nReplace this buyer’s number with dynamic_number, with its tokens replaced, when dialing this buyer.
The token-replaced number or SIP address dialed instead of number when use_dynamic_number is true.
Apply a key press flow group to calls transferred to this buyer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe key press flow group applied when use_with_key_press_flows is true.
The sound playlist played to a caller when this buyer leaves them a voicemail.
\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":"\nSelect which Caller ID will be sent to this Buyer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:display_caller_id, display_fake_caller_id, display_trackdrive_number_id.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display_trackdrive_number_id","full_name":"display_trackdrive_number_id","description":"\nThe Trackdrive number to display when display_caller_id_type=display_trackdrive_number_id
\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":"\nChoose the number of concurrent calls that can be forwarded to this buyer simultaneously.
\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":"\nConvert When Downstream Converts
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAttempt caps limit the number of times a buyer can be attempted in a given interval.
\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":"\nMonthly Attempt Cap
\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":"\nDaily Attempt Cap
\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":"\nHourly Attempt Cap
\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":"\nConnection caps limit the number of times a buyer can be connected in a given interval.
\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":"\nMonthly Connection Cap
\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":"\nDaily Connection Cap
\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":"\nHourly Connection Cap
\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":"\nConversion caps limit the number of times a buyer can convert in a given interval.
\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":"\nMonthly Conversion Cap
\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":"\nDaily Conversion Cap
\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":"\nHourly Conversion Cap
\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":"\nRevenue caps limit the dollar amount that can be paid by a buyer in a given interval.
\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":"\nMonthly $ Revenue Cap
\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":"\nDaily $ Revenue Cap
\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":"\nHourly $ Revenue Cap
\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":"\nDay is an integer representing the day of the week, 0..6, with Sunday == 0. [
\n\n{\n attempt_hourly_limit: 10,\n connection_hourly_limit: 10,\n buyer_conversion_hourly_limit: 10,\n revenue_hourly_limit: 10,\n schedule: [\n {\n day: 0,\n times: ["11:00..13:09", "14:00..15:09"]\n },\n {\n day: 1,\n times: ["11:10..18:39", "19:10..23:39"]\n }\n ]\n}\n\n\n]
\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":"\nDay is an integer representing the day of the week, 0..6, with Sunday == 0. [
\n\n{\n buyer_conversions_attributes: [\n {\n name: '10$ conversion at 1 minute, deduped every 2 hours',\n duration: 60,\n revenue: 10,\n duplicate_timeframe: 7200\n }\n ],\n schedule: [{"day":0,"times":["00:00..23:59"]},{"day":1,"times":["00:00..23:59"]},{"day":2,"times":["00:00..23:59"]},{"day":3,"times":["00:00..23:59"]},{"day":4,"times":["00:00..23:59"]},{"day":5,"times":["00:00..23:59"]},{"day":6,"times":["00:00..23:59"]}]\n}\n\n\n]
\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":"\nThe maximum valid revenue for the current time frame.
\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":"\nThe minimum valid revenue for the current time frame.
\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":"\nBids must be increased/decreased by this amount for the current time frame.
\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":"\nThe number of dollars paid per call in increments of $0.01 for the current time frame.
\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":"\nThe 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.
\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":"\nThe period of time that must elapse before a buyer will pay for the same caller to be transferred.
\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":"\nThis name that will appear in call logs.
\n","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":"\nHow 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.
\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":"\nConversion will only occur if the caller matches these filters.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_attribution_token_values","full_name":"current_conversion_attribution_token_values","description":"\nIf the call converts, these tokens will be applied to the call.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| buyer | Default response format. |
| buyer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| buyer | Default response format. |
| buyer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Copy another buyer?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe id of the buyer you would like to copy.
\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":"\nYour external ID for this buyer.
\n","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":"\nThe 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:’.
\n","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":"\nThe name for this buyer that will appear on menus and in logs.
\n","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":"\nDetermines 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.
\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":"\nPlay 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.
\n","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":"\nThe caller name announced to this buyer when the call connects, with tokens replaced before it is sent.
\n","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":"\nThe number of seconds Trackdrive waits before dialing this buyer after a call is ready to transfer.
\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":"\nDate ranges will be parsed using this time zone.
\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":"\nThe SIP username used when dialing this buyer’s sip: endpoint.
The SIP password used when dialing this buyer’s sip: endpoint.
The known third-party platform this buyer’s number or SIP endpoint belongs to.
\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":"\nThe BuyerFleet this buyer is grouped under.
The list of internal suppression id’s that will be assigned to this buyer.
\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":"\nCallers will be routed to Buyers with matching tokens.
\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":"\nWhen this Buyer is connected to a Caller, the Call will be tagged with these tokens.
\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":"\nPause or unpause the buyer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nEnable or Disable call recordings for this Buyer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nRequire a Trackdrive user logged into your company to have permission to download call recordings for calls transferred to this buyer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAfter answering the call the Buyer must Press 1 before being connected to the Caller.
Trackdrive will use the “Press 1 To Accept” call routing from the current Offer.
Grant access to edit this Buyer, and view calls that it paid for.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe selected users will recieve an email invitation to collaborate on your company.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG:[\"john-smith@gmail.com\", \"example@domain.com\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\nTeam members can view calls made to these Offers that were paid for by their Buyer.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"route_by_type","full_name":"route_by_type","description":"\nConfigure 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.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:tier, revenue, epc.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tier","full_name":"tier","description":"\nWhen 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.
\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":"\nThe number of hours used when calculating the EPC. If there are less than Minimum Required Calls in this timeframe the Assumed EPC will be used instead.
The Assumed EPC will be used until the Buyer has received Minimum Required Calls calls during the EPC Timeframe.
The number of calls required during EPC Timeframe before the real EPC is used insead of the Assumed EPC.
The Weight of this buyer will be divided by the Total Weight of all buyers at this same Tier to get the % of calls this buyer will get within this Tier.
\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":"\nInclude this buyer when Trackdrive searches for a matching buyer before a lead is matched to an offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nPing this buyer before calling the lead back, used with off-hook webhook conversions.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe order this buyer is pinged in relative to other webhook buyers on the same offer. Lower numbers are pinged first.
\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":"\nReplace this buyer’s number with dynamic_number, with its tokens replaced, when dialing this buyer.
The token-replaced number or SIP address dialed instead of number when use_dynamic_number is true.
Apply a key press flow group to calls transferred to this buyer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe key press flow group applied when use_with_key_press_flows is true.
The sound playlist played to a caller when this buyer leaves them a voicemail.
\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":"\nSelect which Caller ID will be sent to this Buyer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:display_caller_id, display_fake_caller_id, display_trackdrive_number_id.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display_trackdrive_number_id","full_name":"display_trackdrive_number_id","description":"\nThe Trackdrive number to display when display_caller_id_type=display_trackdrive_number_id
\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":"\nChoose the number of concurrent calls that can be forwarded to this buyer simultaneously.
\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":"\nConvert When Downstream Converts
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAttempt caps limit the number of times a buyer can be attempted in a given interval.
\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":"\nMonthly Attempt Cap
\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":"\nDaily Attempt Cap
\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":"\nHourly Attempt Cap
\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":"\nConnection caps limit the number of times a buyer can be connected in a given interval.
\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":"\nMonthly Connection Cap
\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":"\nDaily Connection Cap
\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":"\nHourly Connection Cap
\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":"\nConversion caps limit the number of times a buyer can convert in a given interval.
\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":"\nMonthly Conversion Cap
\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":"\nDaily Conversion Cap
\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":"\nHourly Conversion Cap
\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":"\nRevenue caps limit the dollar amount that can be paid by a buyer in a given interval.
\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":"\nMonthly $ Revenue Cap
\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":"\nDaily $ Revenue Cap
\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":"\nHourly $ Revenue Cap
\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":"\nDay is an integer representing the day of the week, 0..6, with Sunday == 0. [
\n\n{\n attempt_hourly_limit: 10,\n connection_hourly_limit: 10,\n buyer_conversion_hourly_limit: 10,\n revenue_hourly_limit: 10,\n schedule: [\n {\n day: 0,\n times: ["11:00..13:09", "14:00..15:09"]\n },\n {\n day: 1,\n times: ["11:10..18:39", "19:10..23:39"]\n }\n ]\n}\n\n\n]
\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":"\nDay is an integer representing the day of the week, 0..6, with Sunday == 0. [
\n\n{\n buyer_conversions_attributes: [\n {\n name: '10$ conversion at 1 minute, deduped every 2 hours',\n duration: 60,\n revenue: 10,\n duplicate_timeframe: 7200\n }\n ],\n schedule: [{"day":0,"times":["00:00..23:59"]},{"day":1,"times":["00:00..23:59"]},{"day":2,"times":["00:00..23:59"]},{"day":3,"times":["00:00..23:59"]},{"day":4,"times":["00:00..23:59"]},{"day":5,"times":["00:00..23:59"]},{"day":6,"times":["00:00..23:59"]}]\n}\n\n\n]
\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":"\nThe maximum valid revenue for the current time frame.
\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":"\nThe minimum valid revenue for the current time frame.
\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":"\nBids must be increased/decreased by this amount for the current time frame.
\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":"\nThe number of dollars paid per call in increments of $0.01 for the current time frame.
\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":"\nThe 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.
\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":"\nThe period of time that must elapse before a buyer will pay for the same caller to be transferred.
\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":"\nThis name that will appear in call logs.
\n","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":"\nHow 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.
\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":"\nConversion will only occur if the caller matches these filters.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current_conversion_attribution_token_values","full_name":"current_conversion_attribution_token_values","description":"\nIf the call converts, these tokens will be applied to the call.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| buyer | Default response format. |
| buyer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Return the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\n","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":"\nYour external ID for this call center.
\n","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":"\nRecord Token Additional
\n","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":"\nYour own identifier for this call center, used to correlate it with a record in an external system.
\n","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":"\nThe ids of the Token Values whose tokens will be additionally applied to calls handled by this call center.
\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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nName
\n","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":"\nDescription
\n","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":"\nYour external ID for this call center.
\n","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":"\nRecord Token Additional
\n","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":"\nYour own identifier for this call center, used to correlate it with a record in an external system.
\n","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":"\nThe ids of the Token Values whose tokens will be additionally applied to calls handled by this call center.
\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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nName
\n","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":"\nDescription
\n","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":"\nYour external ID for this call center.
\n","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":"\nRecord Token Additional
\n","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":"\nYour own identifier for this call center, used to correlate it with a record in an external system.
\n","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":"\nThe ids of the Token Values whose tokens will be additionally applied to calls handled by this call center.
\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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
System Status
\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":"\nKey
\n","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":"\nName
\n","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":"\nText Color
\n","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":"\nBackground Color
\n","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":"\nFont Size
\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":"\nText Shadow Color
\n","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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nFilter Group
\n","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":"\nDescription
\n","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":"\nAn external identifier to associate with this Call Action.
\n","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":"\nWhen enabled, this action is only available while the caller is still on the line.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.
\n","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":"\nHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.
\n","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":"\nThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.
\n","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":"\nWhen enabled, plays a whisper message when an agent clicks this action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Sound Playlist to whisper from, used when message_type is not speak.
\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":"\nWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.
\n","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":"\nWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nSystem Status
\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":"\nKey
\n","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":"\nName
\n","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":"\nText Color
\n","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":"\nBackground Color
\n","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":"\nFont Size
\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":"\nText Shadow Color
\n","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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nFilter Group
\n","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":"\nDescription
\n","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":"\nAn external identifier to associate with this Call Action.
\n","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":"\nWhen enabled, this action is only available while the caller is still on the line.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.
\n","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":"\nHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.
\n","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":"\nThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.
\n","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":"\nWhen enabled, plays a whisper message when an agent clicks this action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Sound Playlist to whisper from, used when message_type is not speak.
\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":"\nWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.
\n","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":"\nWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nSystem Status
\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":"\nKey
\n","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":"\nName
\n","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":"\nText Color
\n","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":"\nBackground Color
\n","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":"\nFont Size
\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":"\nText Shadow Color
\n","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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nFilter Group
\n","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":"\nDescription
\n","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":"\nAn external identifier to associate with this Call Action.
\n","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":"\nWhen enabled, this action is only available while the caller is still on the line.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.
\n","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":"\nHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.
\n","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":"\nThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.
\n","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":"\nWhen enabled, plays a whisper message when an agent clicks this action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Sound Playlist to whisper from, used when message_type is not speak.
\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":"\nWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.
\n","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":"\nWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The internal token name where values are stored.
\n","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":"\nThe friendly human name displayed to users.
\n","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":"\nDisplay a helpful hint to users explaining the purpose of this disposition.
\n","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":"\nShow this disposition on the agent widget?
\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":"\nShow this disposition as a column on tables?
\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":"\nShow this disposition as a column on reports?
\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":"\nMark the call as having been answered?
\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":"\nMark the call as having been handled by an agent?
\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":"\nMark the call as having been handled by a buyer?
\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":"\nMark the call as having been qualified?
\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":"\nTrigger the end of schedule when selecting this disposition?
\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":"\nBlock the caller when selecting this disposition?
\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":"\nAutomatically move to the next lead after selecting this disposition?
\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":"\nRequire the agent to write notes about this call?
\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":"\nWhen enabled, applying this disposition plays a recorded voicemail message to the caller.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition opts the caller out of future contact.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition marks the call as having reached an answering machine.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition keeps the existing conference open instead of ending it.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.
\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":"\nWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe schedule whose actions run when this disposition is applied to a call.
\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":"\nAn external identifier to associate with this disposition.
\n","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":"\nThe hex color of this disposition’s button text, e.g.
\n","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":"\nThe hex color of this disposition’s button background, e.g.
\n","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":"\nThe hex color of this disposition’s button text shadow, e.g.
\n","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":"\nThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.
\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":"\nApply these additional tokens to the call when selecting this disposition?
\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":"\nOnly show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nThe internal token name where values are stored.
\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":"\nThe friendly human name displayed to users.
\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":"\nDisplay a helpful hint to users explaining the purpose of this disposition.
\n","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":"\nShow this disposition on the agent widget?
\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":"\nShow this disposition as a column on tables?
\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":"\nShow this disposition as a column on reports?
\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":"\nMark the call as having been answered?
\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":"\nMark the call as having been handled by an agent?
\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":"\nMark the call as having been handled by a buyer?
\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":"\nMark the call as having been qualified?
\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":"\nTrigger the end of schedule when selecting this disposition?
\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":"\nBlock the caller when selecting this disposition?
\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":"\nAutomatically move to the next lead after selecting this disposition?
\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":"\nRequire the agent to write notes about this call?
\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":"\nWhen enabled, applying this disposition plays a recorded voicemail message to the caller.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition opts the caller out of future contact.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition marks the call as having reached an answering machine.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition keeps the existing conference open instead of ending it.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.
\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":"\nWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe schedule whose actions run when this disposition is applied to a call.
\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":"\nAn external identifier to associate with this disposition.
\n","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":"\nThe hex color of this disposition’s button text, e.g.
\n","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":"\nThe hex color of this disposition’s button background, e.g.
\n","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":"\nThe hex color of this disposition’s button text shadow, e.g.
\n","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":"\nThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.
\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":"\nApply these additional tokens to the call when selecting this disposition?
\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":"\nOnly show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nThe internal token name where values are stored.
\n","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":"\nThe friendly human name displayed to users.
\n","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":"\nDisplay a helpful hint to users explaining the purpose of this disposition.
\n","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":"\nShow this disposition on the agent widget?
\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":"\nShow this disposition as a column on tables?
\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":"\nShow this disposition as a column on reports?
\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":"\nMark the call as having been answered?
\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":"\nMark the call as having been handled by an agent?
\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":"\nMark the call as having been handled by a buyer?
\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":"\nMark the call as having been qualified?
\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":"\nTrigger the end of schedule when selecting this disposition?
\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":"\nBlock the caller when selecting this disposition?
\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":"\nAutomatically move to the next lead after selecting this disposition?
\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":"\nRequire the agent to write notes about this call?
\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":"\nWhen enabled, applying this disposition plays a recorded voicemail message to the caller.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition opts the caller out of future contact.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition marks the call as having reached an answering machine.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition adds the lead’s number to its schedule’s suppression list.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition keeps the existing conference open instead of ending it.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition deletes any scheduled callbacks for the caller on this offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applying this disposition immediately schedules a callback for the lead instead of its normal callback timing.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe percent chance, 0-100, that a waiting scheduled callback is placed instead of the next lead after auto next lead runs.
\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":"\nWhen enabled, this disposition is automatically applied to any call that ends without one chosen. Only one disposition per company can have this enabled.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe schedule whose actions run when this disposition is applied to a call.
\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":"\nAn external identifier to associate with this disposition.
\n","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":"\nThe hex color of this disposition’s button text, e.g.
\n","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":"\nThe hex color of this disposition’s button background, e.g.
\n","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":"\nThe hex color of this disposition’s button text shadow, e.g.
\n","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":"\nThe font size, in pixels, of this disposition’s button label. Clamped between 5 and 30.
\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":"\nApply these additional tokens to the call when selecting this disposition?
\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":"\nOnly show this disposition to agents when the call’s tokens match these. Leave blank to show it for every call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nThe internal id for a call on Trackdrive.
\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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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":"\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Description
\n","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":"\nThis type of recording will be deleted once the retention period has passed.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:call, consumer_and_agent, consumer_and_buyer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retention_seconds","full_name":"retention_seconds","description":"\nIf a recording is older than this many seconds, it will be deleted.
\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":"\nOnly recordings matching this offer will be deleted after the retention period.
\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":"\nOnly recordings matching this Schedule will be deleted after the retention period.
\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":"\nOnly recordings matching this Buyer will be deleted after the retention period.
\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":"\nOnly recordings matching this Traffic Source will be deleted after the retention period.
\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":"\nDescription
\n","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":"\nThis type of recording will be deleted once the retention period has passed.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:call, consumer_and_agent, consumer_and_buyer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retention_seconds","full_name":"retention_seconds","description":"\nIf a recording is older than this many seconds, it will be deleted.
\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":"\nOnly recordings matching this offer will be deleted after the retention period.
\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":"\nOnly recordings matching this Schedule will be deleted after the retention period.
\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":"\nOnly recordings matching this Buyer will be deleted after the retention period.
\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":"\nOnly recordings matching this Traffic Source will be deleted after the retention period.
\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":"\nDescription
\n","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":"\nThis type of recording will be deleted once the retention period has passed.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:call, consumer_and_agent, consumer_and_buyer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retention_seconds","full_name":"retention_seconds","description":"\nIf a recording is older than this many seconds, it will be deleted.
\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":"\nOnly recordings matching this offer will be deleted after the retention period.
\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":"\nOnly recordings matching this Schedule will be deleted after the retention period.
\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":"\nOnly recordings matching this Buyer will be deleted after the retention period.
\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":"\nOnly recordings matching this Traffic Source will be deleted after the retention period.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name of the Answer Group.
\n","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":"\nOptional description for the Answer Group.
\n","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":"\nNumber of single-key answers configured in this group.
\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":"\nCollect a multi-digit response and require callers to press
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMinimum number of digits expected when collecting a numeric response.
\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":"\nMaximum number of digits allowed when collecting a numeric response.
\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":"\nSeconds to wait for input before timing out when collecting a numeric response.
\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":"\nThe token key the caller’s entered digits are saved to when collecting a multi-digit response.
\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":"\nName of the Answer Group.
\n","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":"\nOptional description for the Answer Group.
\n","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":"\nNumber of single-key answers configured in this group.
\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":"\nCollect a multi-digit response and require callers to press
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMinimum number of digits expected when collecting a numeric response.
\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":"\nMaximum number of digits allowed when collecting a numeric response.
\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":"\nSeconds to wait for input before timing out when collecting a numeric response.
\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":"\nThe token key the caller’s entered digits are saved to when collecting a multi-digit response.
\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":"\nName of the Answer Group.
\n","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":"\nOptional description for the Answer Group.
\n","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":"\nNumber of single-key answers configured in this group.
\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":"\nCollect a multi-digit response and require callers to press
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMinimum number of digits expected when collecting a numeric response.
\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":"\nMaximum number of digits allowed when collecting a numeric response.
\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":"\nSeconds to wait for input before timing out when collecting a numeric response.
\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":"\nThe token key the caller’s entered digits are saved to when collecting a multi-digit response.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Answer Group
\n","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":"\nKey Press
\n","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":"\nFilters
\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":"\nThis answer will only be used for calls matching these tokens.
\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":"\nAdditional Tokens
\n","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":"\nThese extra tokens will be applied to calls that use this answer.
\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":"\nDescription
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nAnswer Group
\n","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":"\nKey Press
\n","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":"\nFilters
\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":"\nThis answer will only be used for calls matching these tokens.
\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":"\nAdditional Tokens
\n","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":"\nThese extra tokens will be applied to calls that use this answer.
\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":"\nDescription
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nAnswer Group
\n","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":"\nKey Press
\n","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":"\nFilters
\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":"\nThis answer will only be used for calls matching these tokens.
\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":"\nAdditional Tokens
\n","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":"\nThese extra tokens will be applied to calls that use this answer.
\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":"\nDescription
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"\nAssign the record to this Offer.
\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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Play A Message?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| none | No Message |
| speak | Speak TTS |
| audio | Play Audio |
Choose An Action
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| dial | Forward To Buyers or Agents |
| redirect | Forward To Offer |
| add_to_schedule | Add To Schedule |
| add_to_hold_queue | Place Caller In Hold Queue |
| remove_from_schedule | Remove From Schedule |
| record_voicemail | Record Voicemail |
| request_key_press | Request Key Press |
| block_caller | Block Caller |
| end_call | Hang Up |
| none | Continue Offer Routing |
Assign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nDescribe the purpose of this call flow rule.
\n","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":"\nText To Speech that will be spoken when message_type=speak
The message will be repeated this many times.
\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":"\nThe audio file that will be played when message_type=audio
The schedule that will be used when router_action=add_to_schedule
Calls will be forwarded to these buyers when router_action=dial
Calls will be forwarded to these buyer groups when router_action=dial
Calls will be forwarded to this offer when router_action=redirect
Used when router_type=add_to_hold_queue. How many people can be on hold?
Used when router_type=add_to_hold_queue. Set the hold queue size automatically by taking [Active CC * This Percentage]
Used when router_type=add_to_hold_queue. Maximum number of seconds a caller can be on hold.
Used when router_type=add_to_hold_queue. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.
A short label for this call flow rule shown in the call flow list.
\n","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":"\nThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.
\n","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":"\nThe voice used for the text_to_speech message, Male or Female.
How many seconds to wait for a key press before continuing when router_type=press_1_to_accept.
How the traffic source should be altered when this rule runs.
\n","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":"\nThe traffic source to assign when traffic_source_action_type reassigns the traffic source.
The alternate payout applied when traffic_source_action_type sets a new payout.
How many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.
\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":"\nOnly perform this action when a buyer can be matched for the call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly perform this action when a buyer is available. Companion setting to use_with_find_a_buyer.
Automatically dial the next buyer if the current one does not answer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow many seconds to wait before dialing the next buyer when auto_retry_next_buyer is true.
Route the inbound call asynchronously instead of holding the caller while this rule runs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nUsed when router_type=off_hook_press_to_accept. How many seconds an agent can go without a matching lead before instant agent dialing stops.
Used when router_type=off_hook_press_to_accept. How many outbound calls to place per available agent seat.
Used when router_type=off_hook_press_to_accept. How many seconds an agent has to accept an offered call before it is considered unaccepted.
Used when router_type=off_hook_press_to_accept. How many matching leads must be available before dialing an agent.
Used when router_type=off_hook_press_to_accept. The lookback window, in seconds, used to calculate the dropped call percentage.
Used when router_type=off_hook_press_to_accept. The first dropped call percentage threshold that throttles outbound dialing.
Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_1 is exceeded.
Used when router_type=off_hook_press_to_accept. The second, higher dropped call percentage threshold that throttles outbound dialing further.
Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_2 is exceeded.
Only perform this action if the caller pressed this key.
\n","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":"\nHow many seconds to wait for an agent to disposition a call before moving on.
\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":"\nThe reason recorded on the call when this rule hangs up the call.
\n","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":"\nFire this rule’s outgoing webhooks before performing its action instead of after.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nUsed when router_type=off_hook_press_to_accept. Overflow agents dialed when the primary agents in buyer_ids are unavailable.
[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\nUsed when router_type=off_hook_press_to_accept. Overflow buyer groups dialed when the primary agents in buyer_ids/buyer_group_ids are unavailable.
[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_file","full_name":"voicemail_file","description":"\nThe audio file an instant agent can play to a lead’s answering machine when router_type=off_hook_press_to_accept.
Remove the currently configured voicemail_file.
Custom music played to an instant agent while on hold when router_type=off_hook_press_to_accept. Falls back to the default hold music when blank.
Remove the currently configured hold_music_file.
The key press flow group used to process the caller’s key press response for this rule.
\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":"\nPlay a random file from a sound playlist instead of a single uploaded audio_file.
The sound playlist to play from when use_sound_playlist is true.
Used when router_type=off_hook_press_to_accept. The sound playlist played to an instant agent while on hold.
Used when router_type=off_hook_press_to_accept. The sound playlist an instant agent can play to a lead’s answering machine.
Play a sound playlist after this rule’s action completes.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe sound playlist played after this rule’s action completes, when after_action_sound_playlist_enabled is true.
Assign the record to this Offer.
\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":"\nThe type of Call Flow Rule.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| ask_a_question | Ask A Question And Request An Answer |
| no_greeting_is_played | Handle Call When No Keypress Is Requested |
| connect_ai_voice_agent | Connect AI Voice Agent |
| when_answering_machine_detected | When an answering machine is detected |
| before_answering_machine_detected | Before an answering machine is detected |
| greeting | Play A Greeting Message And Request A Keypress |
| off_hook_press_to_accept | When Getting Instant Agents On The Phone |
| key_press_1 | When 1 is Pressed |
| key_press_2 | When 2 is pressed |
| key_press_3 | When 3 is pressed |
| key_press_4 | When 4 is pressed |
| key_press_5 | When 5 is pressed |
| key_press_6 | When 6 is pressed |
| key_press_7 | When 7 is pressed |
| key_press_8 | When 8 is pressed |
| key_press_9 | When 9 is pressed |
| key_press_# | When # is pressed |
| key_press_* | When * is pressed |
| key_press_0 | When 0 is pressed |
| no_key_press | When nothing is pressed |
| any_other_key_press | When anything is pressed |
| calling_buyer_music | Calling Buyer Music Played to Caller during Transfers |
| whisper | Whisper To Buyer that a Call is being Transferred |
| enter_extension | Enter Extension |
| extension_failed | When an invalid extension is entered |
| zip_code_entry | Enter Zip Code |
| zip_entry_failed | Incorrect Zip Code |
| press_1_to_accept | Whisper to Buyer to Press 1 to Accept a Call |
| press_1_too_slow | Whisper to Buyer that they Pressed 1 Too Slowly |
| add_to_hold_queue | When placed in hold queue |
| hold_queue_is_full | When the hold queue is full |
| hold_queue_max_seconds_exceeded | When the caller has been on hold for longer than max hold seconds |
| no_instant_agent_available | When no instant agent is available during an inbound call from a consumer |
| no_instant_agent_available_outbound | When no instant agent is available during an outbound call to a consumer |
| when_instant_agent_transfers_to_buyer | When an instant agent transfers to a buyer |
| when_buyer_hangup_before_duration | When A Buyer Hangs Up Before Duration |
| no_buyers_have_open_concurrency_cap | When no buyers have open concurrency cap |
| all_buyers_closed | When no buyers are open |
| no_buyer_answered | When no buyers answer |
| no_buyers_match | When no buyers have matching filters |
| tag_validation_failed | Token Entry Failed |
| traffic_source_capped | When the traffic source is capped |
| caller_hang_up_before_conference | When the caller hangs up before being connected to a buyer |
Play A Message?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| none | No Message |
| speak | Speak TTS |
| audio | Play Audio |
Choose An Action
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| dial | Forward To Buyers or Agents |
| redirect | Forward To Offer |
| add_to_schedule | Add To Schedule |
| add_to_hold_queue | Place Caller In Hold Queue |
| remove_from_schedule | Remove From Schedule |
| record_voicemail | Record Voicemail |
| request_key_press | Request Key Press |
| block_caller | Block Caller |
| end_call | Hang Up |
| none | Continue Offer Routing |
Assign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nDescribe the purpose of this call flow rule.
\n","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":"\nText To Speech that will be spoken when message_type=speak
The message will be repeated this many times.
\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":"\nThe audio file that will be played when message_type=audio
The schedule that will be used when router_action=add_to_schedule
Calls will be forwarded to these buyers when router_action=dial
Calls will be forwarded to these buyer groups when router_action=dial
Calls will be forwarded to this offer when router_action=redirect
Used when router_type=add_to_hold_queue. How many people can be on hold?
Used when router_type=add_to_hold_queue. Set the hold queue size automatically by taking [Active CC * This Percentage]
Used when router_type=add_to_hold_queue. Maximum number of seconds a caller can be on hold.
Used when router_type=add_to_hold_queue. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.
A short label for this call flow rule shown in the call flow list.
\n","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":"\nThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.
\n","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":"\nThe voice used for the text_to_speech message, Male or Female.
How many seconds to wait for a key press before continuing when router_type=press_1_to_accept.
How the traffic source should be altered when this rule runs.
\n","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":"\nThe traffic source to assign when traffic_source_action_type reassigns the traffic source.
The alternate payout applied when traffic_source_action_type sets a new payout.
How many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.
\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":"\nOnly perform this action when a buyer can be matched for the call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly perform this action when a buyer is available. Companion setting to use_with_find_a_buyer.
Automatically dial the next buyer if the current one does not answer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow many seconds to wait before dialing the next buyer when auto_retry_next_buyer is true.
Route the inbound call asynchronously instead of holding the caller while this rule runs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nUsed when router_type=off_hook_press_to_accept. How many seconds an agent can go without a matching lead before instant agent dialing stops.
Used when router_type=off_hook_press_to_accept. How many outbound calls to place per available agent seat.
Used when router_type=off_hook_press_to_accept. How many seconds an agent has to accept an offered call before it is considered unaccepted.
Used when router_type=off_hook_press_to_accept. How many matching leads must be available before dialing an agent.
Used when router_type=off_hook_press_to_accept. The lookback window, in seconds, used to calculate the dropped call percentage.
Used when router_type=off_hook_press_to_accept. The first dropped call percentage threshold that throttles outbound dialing.
Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_1 is exceeded.
Used when router_type=off_hook_press_to_accept. The second, higher dropped call percentage threshold that throttles outbound dialing further.
Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_2 is exceeded.
Only perform this action if the caller pressed this key.
\n","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":"\nHow many seconds to wait for an agent to disposition a call before moving on.
\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":"\nThe reason recorded on the call when this rule hangs up the call.
\n","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":"\nFire this rule’s outgoing webhooks before performing its action instead of after.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nUsed when router_type=off_hook_press_to_accept. Overflow agents dialed when the primary agents in buyer_ids are unavailable.
[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\nUsed when router_type=off_hook_press_to_accept. Overflow buyer groups dialed when the primary agents in buyer_ids/buyer_group_ids are unavailable.
[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_file","full_name":"voicemail_file","description":"\nThe audio file an instant agent can play to a lead’s answering machine when router_type=off_hook_press_to_accept.
Remove the currently configured voicemail_file.
Custom music played to an instant agent while on hold when router_type=off_hook_press_to_accept. Falls back to the default hold music when blank.
Remove the currently configured hold_music_file.
The key press flow group used to process the caller’s key press response for this rule.
\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":"\nPlay a random file from a sound playlist instead of a single uploaded audio_file.
The sound playlist to play from when use_sound_playlist is true.
Used when router_type=off_hook_press_to_accept. The sound playlist played to an instant agent while on hold.
Used when router_type=off_hook_press_to_accept. The sound playlist an instant agent can play to a lead’s answering machine.
Play a sound playlist after this rule’s action completes.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe sound playlist played after this rule’s action completes, when after_action_sound_playlist_enabled is true.
Assign the record to this Offer.
\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":"\nWhen false, this rule is disabled and skipped. Used to pause a call flow rule, such as an off_hook_press_to_accept flow, without deleting it.
The answer group used to process the caller’s response when router_type=ask_a_question.
Play A Message?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| none | No Message |
| speak | Speak TTS |
| audio | Play Audio |
Choose An Action
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| dial | Forward To Buyers or Agents |
| redirect | Forward To Offer |
| add_to_schedule | Add To Schedule |
| add_to_hold_queue | Place Caller In Hold Queue |
| remove_from_schedule | Remove From Schedule |
| record_voicemail | Record Voicemail |
| request_key_press | Request Key Press |
| block_caller | Block Caller |
| end_call | Hang Up |
| none | Continue Offer Routing |
Assign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nDescribe the purpose of this call flow rule.
\n","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":"\nText To Speech that will be spoken when message_type=speak
The message will be repeated this many times.
\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":"\nThe audio file that will be played when message_type=audio
The schedule that will be used when router_action=add_to_schedule
Calls will be forwarded to these buyers when router_action=dial
Calls will be forwarded to these buyer groups when router_action=dial
Calls will be forwarded to this offer when router_action=redirect
Used when router_type=add_to_hold_queue. How many people can be on hold?
Used when router_type=add_to_hold_queue. Set the hold queue size automatically by taking [Active CC * This Percentage]
Used when router_type=add_to_hold_queue. Maximum number of seconds a caller can be on hold.
Used when router_type=add_to_hold_queue. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.
A short label for this call flow rule shown in the call flow list.
\n","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":"\nThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.
\n","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":"\nThe voice used for the text_to_speech message, Male or Female.
How many seconds to wait for a key press before continuing when router_type=press_1_to_accept.
How the traffic source should be altered when this rule runs.
\n","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":"\nThe traffic source to assign when traffic_source_action_type reassigns the traffic source.
The alternate payout applied when traffic_source_action_type sets a new payout.
How many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.
\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":"\nOnly perform this action when a buyer can be matched for the call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly perform this action when a buyer is available. Companion setting to use_with_find_a_buyer.
Automatically dial the next buyer if the current one does not answer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow many seconds to wait before dialing the next buyer when auto_retry_next_buyer is true.
Route the inbound call asynchronously instead of holding the caller while this rule runs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nUsed when router_type=off_hook_press_to_accept. How many seconds an agent can go without a matching lead before instant agent dialing stops.
Used when router_type=off_hook_press_to_accept. How many outbound calls to place per available agent seat.
Used when router_type=off_hook_press_to_accept. How many seconds an agent has to accept an offered call before it is considered unaccepted.
Used when router_type=off_hook_press_to_accept. How many matching leads must be available before dialing an agent.
Used when router_type=off_hook_press_to_accept. The lookback window, in seconds, used to calculate the dropped call percentage.
Used when router_type=off_hook_press_to_accept. The first dropped call percentage threshold that throttles outbound dialing.
Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_1 is exceeded.
Used when router_type=off_hook_press_to_accept. The second, higher dropped call percentage threshold that throttles outbound dialing further.
Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_2 is exceeded.
Only perform this action if the caller pressed this key.
\n","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":"\nHow many seconds to wait for an agent to disposition a call before moving on.
\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":"\nThe reason recorded on the call when this rule hangs up the call.
\n","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":"\nFire this rule’s outgoing webhooks before performing its action instead of after.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nUsed when router_type=off_hook_press_to_accept. Overflow agents dialed when the primary agents in buyer_ids are unavailable.
[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\nUsed when router_type=off_hook_press_to_accept. Overflow buyer groups dialed when the primary agents in buyer_ids/buyer_group_ids are unavailable.
[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_file","full_name":"voicemail_file","description":"\nThe audio file an instant agent can play to a lead’s answering machine when router_type=off_hook_press_to_accept.
Remove the currently configured voicemail_file.
Custom music played to an instant agent while on hold when router_type=off_hook_press_to_accept. Falls back to the default hold music when blank.
Remove the currently configured hold_music_file.
The key press flow group used to process the caller’s key press response for this rule.
\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":"\nPlay a random file from a sound playlist instead of a single uploaded audio_file.
The sound playlist to play from when use_sound_playlist is true.
Used when router_type=off_hook_press_to_accept. The sound playlist played to an instant agent while on hold.
Used when router_type=off_hook_press_to_accept. The sound playlist an instant agent can play to a lead’s answering machine.
Play a sound playlist after this rule’s action completes.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe sound playlist played after this rule’s action completes, when after_action_sound_playlist_enabled is true.
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| call | Default response format. |
| call_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Return the next page of results. A per_page request parameter > 10 is not allowed, cursor must be used instead.
\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":"\nThe 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 metadata.next_cursor. 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.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Dynamic Date String such as “Today” or “This Year”
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:Last 5 Min, Last 15 Min, Last 30 Min, Last Hour, Last 4 Hours, Last 6 Hours, Last 12 Hours, Last Day, Last 2 Days, Today, Yesterday, This Week, Last Week, This Month, Last Month, This Quarter, Last Quarter, Last 6 Months, This Year, Last Year, Lifetime, Custom Range.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_repeat_caller","full_name":"offer_repeat_caller","description":"\nMatch calls where the Traffic Source had a repeat caller.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the Buyer had a repeat caller.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDid the buyer convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDid the traffic source convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that are on-going
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nWas the call placed on hold?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that have a recording.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nWhether this call’s buyer or traffic source has converted.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the callerID was a duplicate against the Buyer’s conversion settings.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the callerID was a duplicate against the Traffic Source’s conversion settings.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that didn’t connect to a Buyer
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nCalls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.
\n","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":"\nWill 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.
\n","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":"\nSort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:direction, updated_at, start_app_duration, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, third_party_cost, charge_total, answered_duration, agent_duration, status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\nSort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\nRefer to the number api for details
\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":"\nRefer to the offer api for details
\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":"\nSchedule internal id.
\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":"\nRefer to the traffic source api for details
\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":"\nRefer to the buyer api for details
\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":"\nBuyer Group Internal ids.
\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":"\nRefer to the Number Pool api for details
\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":"\nAn Integer number eg: 12345
\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":"\nRefer to the provider api for details
\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":"\nMatch calls that were placed by this caller.
\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":"\nMatch results that have this status.
\n","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":"\nDate formatted like 2016-01-01 12:00:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:00:15 -0500
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| call | Default response format. |
| call_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
The caller number. EG: +17191112222
\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":"\nHow many results to return per page. The default is 25.
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| call | Default response format. |
| call_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Return the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Match calls where the Traffic Source had a repeat caller.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the Buyer had a repeat caller.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDid the buyer convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDid the traffic source convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that are on-going
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nWas the call placed on hold?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that have a recording.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nWhether this call’s buyer or traffic source has converted.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the callerID was a duplicate against the Buyer’s conversion settings.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the callerID was a duplicate against the Traffic Source’s conversion settings.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that didn’t connect to a Buyer
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nCalls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.
\n","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":"\nWill 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.
\n","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":"\nSort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:direction, updated_at, start_app_duration, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, third_party_cost, charge_total, answered_duration, agent_duration, status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\nSort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\nRefer to the number api for details
\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":"\nRefer to the offer api for details
\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":"\nSchedule internal id.
\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":"\nRefer to the traffic source api for details
\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":"\nRefer to the buyer api for details
\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":"\nBuyer Group Internal ids.
\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":"\nRefer to the Number Pool api for details
\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":"\nAn Integer number eg: 12345
\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":"\nRefer to the provider api for details
\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":"\nMatch calls that were placed by this caller.
\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":"\nMatch results that have this status.
\n","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":"\nDate formatted like 2016-01-01 12:00:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:00:15 -0500
\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":"\nGroup calls by one of these attributes.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:buyer_converted, offer_converted, status, created_at_five_minutes, created_at_day, created_at_week, created_at_month.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stat","full_name":"stat","description":"\nReturn statistics on the grouped calls by one of these numeric columns.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:count, revenue, profit, cost.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\nDate formatted like 2016-01-01 12:25:15 -0500
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\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":"\nReturn the next page of results.
\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":"\nMatch calls where the Traffic Source had a repeat caller.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the Buyer had a repeat caller.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDid the buyer convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDid the traffic source convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that are on-going
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nWas the call placed on hold?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that have a recording.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nWhether this call’s buyer or traffic source has converted.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the callerID was a duplicate against the Buyer’s conversion settings.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls where the callerID was a duplicate against the Traffic Source’s conversion settings.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nMatch calls that didn’t connect to a Buyer
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nCalls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.
\n","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":"\nWill 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.
\n","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":"\nSort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:direction, updated_at, start_app_duration, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, third_party_cost, charge_total, answered_duration, agent_duration, status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\nSort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_id","full_name":"number_id","description":"\nRefer to the number api for details
\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":"\nRefer to the offer api for details
\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":"\nSchedule internal id.
\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":"\nRefer to the traffic source api for details
\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":"\nRefer to the buyer api for details
\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":"\nBuyer Group Internal ids.
\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":"\nRefer to the Number Pool api for details
\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":"\nAn Integer number eg: 12345
\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":"\nRefer to the provider api for details
\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":"\nMatch calls that were placed by this caller.
\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":"\nMatch results that have this status.
\n","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":"\nDate formatted like 2016-01-01 12:00:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:00:15 -0500
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| call | Default response format. |
| call_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
The call will originate from this address (+E.164 formatted phone number.) Example: +18665550001
\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":"\nThe call will be placed to this receiving address (+E.164 formatted phone number.) Example: +18665550001
\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":"\nOptional. Associate this call with this lead.
\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":"\nOptional. 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.
\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":"\nOptional. Associate this call with a matching lead on this offer. If no lead currently exists, one will be created on this offer.
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| call | Default response format. |
| call_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Find the call by Call ID or Call UUID.
Example ID 123895022.
Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479
Advanced Call Analysis provides detailed event logs of telephonic interactions. This feature captures an array of events including call channels, agent interactions, outgoing HTTP requests, buyer pings, call recordings, and more. Each advanced call analysis request incurs a usage charge billed at your account’s Per Advanced Call Analysis Rate, shown on your Rate Sheet. The default rate is 0.0002/request.
\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":"\nUpdate a call by Call ID or Call UUID with contact fields, revenue, payout, and more.
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| call | Default response format. |
| call_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Find the call by Call ID or Call UUID.
Example ID 123895022.
Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479
Custom contact fields defined on the offer.
EG: {first_name: "John", last_name: "Smith", zip_code: "90210"}
The revenue paid out for the call.
\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":"\nAdd 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)
\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":"\nAdd this amount to the call’s current payout.
\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":"\nDid the buyer convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nUpdate the winning Buyer that is assigned to this call.
\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":"\nThe amount paid to the traffic source.
\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":"\nDid the traffic source convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nUpdate the Traffic Source that is assigned to this call.
\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":"\nPass an ID belonging to an Agent Script & Field Type to select that Custom Contact Field Type for this call.
Manually refire the listed outgoing webhook ids against this call.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manual_transcribe","full_name":"manual_transcribe","description":"\nManually transcribe this call using the default transcription group.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nCall Disposition
\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":"\nNotes
\n","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":"\nBlock or unblock this caller’s number. Blocking prevents outbound calls, SMS, and email to them, and blocks their inbound calls and SMS too.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Agent Script this call is showing to the agent, which controls its custom fields and instructions.
\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":"\nA human readable description of the record.
\n","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":"\nSet to true to immediately hang up this call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe externally hosted recording URL for this call, before it is copied to Trackdrive’s own storage.
\n","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":"\nSet to true to reapply this call’s buyer and offer conversion logic using its current revenue and payout.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nManually refire the webhooks associated with this call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nSchedule an immediate callback.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nSchedule a callback sometime in the next hour.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nUpdate a call’s revenue and buyer_converted using the call’s caller_id and offer_token
The caller ID for the call that will be updated.
\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":"\nThe Dynamic Number Insertion token for the offer.
Pass this optional parameter to restrict the call update to calls made in the last call_timeframe 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.
Set the call’s revenue to this amount. For example pass 10.50 to set the revenue to 10.50
\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":"\nAdd 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)
\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":"\nAdd this amount to the call’s current payout.
\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":"\nCall Disposition
\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":"\nNotes
\n","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":"\nDid the buyer convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"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&add_revenue=5\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/send_key_press","name":"send_key_press","apis":[{"api_url":"/api/v1/calls/send_key_press","http_method":"POST","short_description":"Trigger a key press flow","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\nFind the call by Call ID or Call UUID.
Example ID 123895022.
Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479
DTMF digit
\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":"\nUpdate the call with this data. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'}
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| call | Default response format. |
| call_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Find the call by Call ID or Call UUID.
Example ID 123895022.
Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_id","full_name":"owner_id","description":"\nThe ID for the record that owns this record.
\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":"\nThe type of record that owns this record.
\n","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":"\nReturn the next page of results. A per_page request parameter > 10 is not allowed, cursor must be used instead.
\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":"\nThe 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 metadata.next_cursor. 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.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Different types of charges including calls, SMS, transcriptions, reporting, and number-related fees.
\n","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":"\nRefer to the offer api for details
\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":"\nSchedule internal id.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The type of collection to return.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| buyer_group_table_details | Buyer Group Table Details |
| buyer_table_details | Buyer Table Details |
| call_buyer_id | Call Buyer |
| call_category | Call Category |
| call_child_buyer_id | Call Child Buyer |
| call_contact_field_type | Call Contact Field Type |
| call_country | Call Country |
| call_hangup_cause_code | Call Hangup Cause Code |
| call_hangup_cause_status | Call Hangup Cause Status |
| call_hung_up_by | Call Hung Up By |
| call_offer_id | Call Offer |
| call_report_table_details | Call Report Table Details |
| call_state_province | Call State Province |
| call_status | Call Status |
| call_sub_id | Call Sub |
| call_table_details | Call Table Details |
| call_token_values_map | Call Token Values Map |
| call_zip_postal_code | Zip / Postal Codes On Calls |
| countries | Countries |
| facet_categories | Facet Categories |
| lead_contact_field_type | Lead Contact Field Type |
| lead_country | Lead Country |
| lead_dial_number_id | Lead Dial Number |
| lead_dial_tier | Lead Dial Tier |
| lead_lead_import_id | Lead Lead Import |
| lead_report_table_details | Lead Report Table Details |
| lead_schedule_trigger_type | Lead Schedule Trigger Type |
| lead_sms_number_id | Lead Sms Number |
| lead_state_province | Lead State Province |
| lead_status | Lead Status |
| lead_status | Lead Status |
| lead_sub_id | Lead Sub |
| lead_table_details | Lead Table Details |
| lead_token_values_map | Lead Token Values Map |
| lead_zip_postal_code | Lead Zip Postal Code |
| number_table_details | Number Table Details |
| offer_table_details | Offer Table Details |
| ring_pool_table_details | Ring Pool Table Details |
| schedule_table_details | Schedule Table Details |
| states | States |
| time_zone | Time Zone |
| traffic_source_table_details | Traffic Source Table Details |
| webhook_ips | Webhook Ips |
Dynamic Date String such as “Today” or “This Year”
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:Last 5 Min, Last 15 Min, Last 30 Min, Last Hour, Last 4 Hours, Last 6 Hours, Last 12 Hours, Last Day, Last 2 Days, Today, Yesterday, This Week, Last Week, This Month, Last Month, This Quarter, Last Quarter, Last 6 Months, This Year, Last Year, Lifetime, Custom Range.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The Contact Field this picklist value belongs to.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Assign the record to this Contact Field.
\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":"\nValue
\n","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":"\nDisplay Name For Value
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nOnly offers this picklist value for calls matching these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nAssign the record to this Contact Field.
\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":"\nValue
\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":"\nDisplay Name For Value
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nOnly offers this picklist value for calls matching these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nAssign the record to this Contact Field.
\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":"\nValue
\n","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":"\nDisplay Name For Value
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nOnly offers this picklist value for calls matching these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nThe offer this Agent Script belongs to.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Assign the record to this Offer.
\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":"\nAgent Script Display Name
\n","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":"\nA unique value that will be submitted with leads to select this field type and agent script.
\n","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":"\nThis 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.
\n","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":"\nThese fields will be visible when this field_type is selected.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nUses this Agent Script by default when a call doesn’t match any other Agent Script’s filters.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nCustom JavaScript run alongside this Agent Script while agents are on the call.
\n","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":"\nThe Jornaya campaign id associated with this Agent Script.
\n","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":"\nOnly uses this Agent Script for calls matching the token filters below.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly uses this Agent Script for calls matching these token values.
Obtain token value ids from the Token Values collection.
When this Agent Script is used on a call, the call will be tagged with these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nAgent Script Display Name
\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":"\nAssign the record to this Offer.
\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":"\nA unique value that will be submitted with leads to select this field type and agent script.
\n","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":"\nThis 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.
\n","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":"\nThese fields will be visible when this field_type is selected.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nUses this Agent Script by default when a call doesn’t match any other Agent Script’s filters.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nCustom JavaScript run alongside this Agent Script while agents are on the call.
\n","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":"\nThe Jornaya campaign id associated with this Agent Script.
\n","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":"\nOnly uses this Agent Script for calls matching the token filters below.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly uses this Agent Script for calls matching these token values.
Obtain token value ids from the Token Values collection.
When this Agent Script is used on a call, the call will be tagged with these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nAssign the record to this Offer.
\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":"\nAgent Script Display Name
\n","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":"\nA unique value that will be submitted with leads to select this field type and agent script.
\n","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":"\nThis 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.
\n","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":"\nThese fields will be visible when this field_type is selected.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nUses this Agent Script by default when a call doesn’t match any other Agent Script’s filters.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nCustom JavaScript run alongside this Agent Script while agents are on the call.
\n","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":"\nThe Jornaya campaign id associated with this Agent Script.
\n","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":"\nOnly uses this Agent Script for calls matching the token filters below.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly uses this Agent Script for calls matching these token values.
Obtain token value ids from the Token Values collection.
When this Agent Script is used on a call, the call will be tagged with these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| contact_field | Contact Field |
| contact_field_form | Contact Field Form |
Assign the record to this Offer.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Assign the record to this Offer.
\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":"\nThe internal token name where values are stored.
\n","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":"\nIs this field required?
\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":"\nThe friendly human name displayed to users.
\n","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":"\nDisplay a helpful hint to users explaining the purpose of this field.
\n","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":"\nField Type
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean, expression, hidden.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"decimal_places","full_name":"decimal_places","description":"\nDecimal values/expressions will be rounded to this many decimal places.
\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":"\nExpression Formatter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\nExpression
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nRequires this field to have a value before a Lead can be created.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequires this field to have a value before this Offer’s buyers can be pinged.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nA custom HTML id for this field’s input, used to target it with your own CSS or JavaScript.
\n","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":"\nThe background color used to display this field’s token, as a hex code.
\n","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":"\nThe text color used to display this field’s token, as a hex code.
\n","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":"\nIncludes this field in the integration guide and posting instructions shown to your traffic sources.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field as a column in tables throughout the app.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field as an option when building reports.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field on the manual dialer screen.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nConsiders this field’s value when applying buyer filters before calling.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAllows a blank value to pass buyer filters instead of blocking the call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe minimum acceptable value, used when the field type is Decimal or Integer.
\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":"\nThe maximum acceptable value, used when the field type is Decimal or Integer.
\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":"\nThe earliest acceptable date, used when the field type is Time.
\n","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":"\nThe latest acceptable date, used when the field type is Time.
\n","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":"\nShows a date picker for entering this field’s value, used when the field type is Time.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRestricts the date picker to future dates only, used when the field type is Time.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe label displayed for a true value, used when the field type is Boolean.
\n","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":"\nThe label displayed for a false value, used when the field type is Boolean.
\n","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":"\nIncludes a blank option in the list of acceptable values, used when the field type is Boolean or String.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhere the list of acceptable values for this field comes from.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:custom, countries, usa_states, canada_provinces.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_pattern_validation","full_name":"check_pattern_validation","description":"\nValidates this field’s value against the pattern selected in value_pattern_validation.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe pattern this field’s value must match, used when check_pattern_validation is enabled.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:date_YYYY-MM-DD, date_DD/MM/YYYY, date_DD-MM-YYYY, date_MM/DD/YYYY, date_MM-DD-YYYY, email.","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":"\nAssign the record to this Offer.
\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":"\nThe internal token name where values are stored.
\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":"\nIs this field required?
\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":"\nThe friendly human name displayed to users.
\n","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":"\nDisplay a helpful hint to users explaining the purpose of this field.
\n","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":"\nField Type
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean, expression, hidden.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"decimal_places","full_name":"decimal_places","description":"\nDecimal values/expressions will be rounded to this many decimal places.
\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":"\nExpression Formatter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\nExpression
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nRequires this field to have a value before a Lead can be created.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequires this field to have a value before this Offer’s buyers can be pinged.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nA custom HTML id for this field’s input, used to target it with your own CSS or JavaScript.
\n","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":"\nThe background color used to display this field’s token, as a hex code.
\n","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":"\nThe text color used to display this field’s token, as a hex code.
\n","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":"\nIncludes this field in the integration guide and posting instructions shown to your traffic sources.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field as a column in tables throughout the app.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field as an option when building reports.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field on the manual dialer screen.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nConsiders this field’s value when applying buyer filters before calling.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAllows a blank value to pass buyer filters instead of blocking the call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe minimum acceptable value, used when the field type is Decimal or Integer.
\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":"\nThe maximum acceptable value, used when the field type is Decimal or Integer.
\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":"\nThe earliest acceptable date, used when the field type is Time.
\n","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":"\nThe latest acceptable date, used when the field type is Time.
\n","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":"\nShows a date picker for entering this field’s value, used when the field type is Time.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRestricts the date picker to future dates only, used when the field type is Time.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe label displayed for a true value, used when the field type is Boolean.
\n","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":"\nThe label displayed for a false value, used when the field type is Boolean.
\n","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":"\nIncludes a blank option in the list of acceptable values, used when the field type is Boolean or String.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhere the list of acceptable values for this field comes from.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:custom, countries, usa_states, canada_provinces.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_pattern_validation","full_name":"check_pattern_validation","description":"\nValidates this field’s value against the pattern selected in value_pattern_validation.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe pattern this field’s value must match, used when check_pattern_validation is enabled.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:date_YYYY-MM-DD, date_DD/MM/YYYY, date_DD-MM-YYYY, date_MM/DD/YYYY, date_MM-DD-YYYY, email.","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":"\nAssign the record to this Offer.
\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":"\nThe internal token name where values are stored.
\n","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":"\nIs this field required?
\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":"\nThe friendly human name displayed to users.
\n","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":"\nDisplay a helpful hint to users explaining the purpose of this field.
\n","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":"\nField Type
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean, expression, hidden.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"decimal_places","full_name":"decimal_places","description":"\nDecimal values/expressions will be rounded to this many decimal places.
\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":"\nExpression Formatter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"value_expression","full_name":"value_expression","description":"\nExpression
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nRequires this field to have a value before a Lead can be created.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequires this field to have a value before this Offer’s buyers can be pinged.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nA custom HTML id for this field’s input, used to target it with your own CSS or JavaScript.
\n","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":"\nThe background color used to display this field’s token, as a hex code.
\n","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":"\nThe text color used to display this field’s token, as a hex code.
\n","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":"\nIncludes this field in the integration guide and posting instructions shown to your traffic sources.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field as a column in tables throughout the app.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field as an option when building reports.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nShows this field on the manual dialer screen.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nConsiders this field’s value when applying buyer filters before calling.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAllows a blank value to pass buyer filters instead of blocking the call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe minimum acceptable value, used when the field type is Decimal or Integer.
\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":"\nThe maximum acceptable value, used when the field type is Decimal or Integer.
\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":"\nThe earliest acceptable date, used when the field type is Time.
\n","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":"\nThe latest acceptable date, used when the field type is Time.
\n","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":"\nShows a date picker for entering this field’s value, used when the field type is Time.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRestricts the date picker to future dates only, used when the field type is Time.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe label displayed for a true value, used when the field type is Boolean.
\n","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":"\nThe label displayed for a false value, used when the field type is Boolean.
\n","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":"\nIncludes a blank option in the list of acceptable values, used when the field type is Boolean or String.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhere the list of acceptable values for this field comes from.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:custom, countries, usa_states, canada_provinces.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_pattern_validation","full_name":"check_pattern_validation","description":"\nValidates this field’s value against the pattern selected in value_pattern_validation.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe pattern this field’s value must match, used when check_pattern_validation is enabled.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:date_YYYY-MM-DD, date_DD/MM/YYYY, date_DD-MM-YYYY, date_MM/DD/YYYY, date_MM-DD-YYYY, email.","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nThe file containing phone numbers to block or unblock, used when select_import_type is file.
\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":"\nApply Block Or Unblock
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:block, unblock.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"select_import_type","full_name":"select_import_type","description":"\nUpload Import File Or Text
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:file, text_blob.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file_blob","full_name":"import_file_blob","description":"\nText Blob
\n","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":"\nThe column header from your uploaded file that contains the phone numbers to block or unblock.
\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":"\nName
\n","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":"\nThe file containing phone numbers to block or unblock, used when select_import_type is file.
\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":"\nApply Block Or Unblock
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:block, unblock.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"select_import_type","full_name":"select_import_type","description":"\nUpload Import File Or Text
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:file, text_blob.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file_blob","full_name":"import_file_blob","description":"\nText Blob
\n","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":"\nThe column header from your uploaded file that contains the phone numbers to block or unblock.
\n","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":"\nA human readable description of this import.
\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":"\nName
\n","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":"\nThe file containing phone numbers to block or unblock, used when select_import_type is file.
\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":"\nApply Block Or Unblock
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:block, unblock.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"select_import_type","full_name":"select_import_type","description":"\nUpload Import File Or Text
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:file, text_blob.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"import_file_blob","full_name":"import_file_blob","description":"\nText Blob
\n","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":"\nThe column header from your uploaded file that contains the phone numbers to block or unblock.
\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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Add a caller_id to your company blacklist, preventing all inbound and outbound interactions.
\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":"\nLookup a contact by internal id, or by the 10+ digit telephone number. For example:
To find a number using trackdrive’s internal id pass id=185923
To find a number using the phone number pass id=18005002562
Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls & sms.
\n","required":false,"allow_nil":false,"allow_blank":false,"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":"\nLookup a contact by internal id, or by the 10+ digit telephone number. For example:
To find a number using trackdrive’s internal id pass id=185923
To find a number using the phone number pass id=18005002562
Mark a contact as opt-out or opt-in. Opt-out prevents outbound actions (calls, sms, emails), but allows the lead to dial in to your offers to resubscribe.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nBlock or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls & sms.
\n","required":false,"allow_nil":false,"allow_blank":false,"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":"\nA unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Description
\n","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":"\nName
\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":"\nDescription
\n","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":"\nName
\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":"\nDescription
\n","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":"\nName
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Description
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_data","full_name":"override_data","description":"\nOverride Existing Data
\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":"\nMap Contact Field Group IDs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nOnly run this data append for leads matching these token filters. Leads that don’t match are skipped.
\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":"\nThese tokens will be applied to leads processed by this data append.
\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":"\nData Append Group ID
\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":"\nAppend Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| free_zip_code | Free Zip Code |
| zip_code | Advanced Zip Code |
| address | Address Data |
| contact | Contact Data |
| contact_plus | Contact+ Data |
| all | All Data |
Name
\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":"\nDescription
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_data","full_name":"override_data","description":"\nOverride Existing Data
\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":"\nMap Contact Field Group IDs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nOnly run this data append for leads matching these token filters. Leads that don’t match are skipped.
\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":"\nThese tokens will be applied to leads processed by this data append.
\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":"\nData Append Group ID
\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":"\nAppend Type
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| free_zip_code | Free Zip Code |
| zip_code | Advanced Zip Code |
| address | Address Data |
| contact | Contact Data |
| contact_plus | Contact+ Data |
| all | All Data |
Name
\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":"\nDescription
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_data","full_name":"override_data","description":"\nOverride Existing Data
\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":"\nMap Contact Field Group IDs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nOnly run this data append for leads matching these token filters. Leads that don’t match are skipped.
\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":"\nThese tokens will be applied to leads processed by this data append.
\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":"\nData Append Group ID
\n","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":"\nAppend Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| free_zip_code | Free Zip Code |
| zip_code | Advanced Zip Code |
| address | Address Data |
| contact | Contact Data |
| contact_plus | Contact+ Data |
| all | All Data |
Name
\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":"\nRequest data for caller number. This incurs a per API request usage charge on your company based on data type requested.
\n","errors":[],"params":[{"name":"caller_number","full_name":"caller_number","description":"\nThe caller number to retrieve data for.
\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":"\nThe 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.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:free_zip_code, zip_code, address, contact, contact_plus, all.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"\nSpecify the columns you would like returned, e.g. columns=zip_code,city,state
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Redirects to a time-limited presigned S3 URL for the export file. Returns 404 if the file is not ready.
\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":"\nCreate 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.
\n","errors":[],"params":[{"name":"data_type","full_name":"data_type","description":"\nThe type of data being exported.
\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":"\nName of the export.
\n","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":"\nStart of the date range filter for exported records.
\n","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":"\nEnd of the date range filter for exported records.
\n","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":"\nA 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.
\n","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":"\nArray of column names to include in the export. Defaults to all available columns for the data type if omitted.
\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":"\nSerializer format for the export (e.g. call_grid for calls).
\n","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":"\nDate ranges in the export filters will be parsed using this time zone.
\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":"\nEmail addresses to notify when this export finishes.
\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":"\nMatch calls where the caller ID was withheld or anonymous.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls where a Buyer was attempted.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls where a Buyer connected.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls where the callerID was a duplicate against the Buyer’s conversion settings.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls where the Buyer had a repeat caller.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that have disconnected.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch leads that have no pending next action, when data_type is lead.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls where a barge occurred (a buyer or agent joined an in-progress call).
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that connected to a Buyer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch leads that have at least one call, when data_type is lead.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that generated a downstream call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch records that have an email address.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch leads that have a pending next action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that have a recording.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that have a scheduled callback.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that have a Traffic Source assigned.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that left a voicemail.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that are on-going
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that were placed internally rather than by an external caller.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that are themselves a scheduled callback.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that left a voicemail.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch leads that were manually opted in.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch leads that were manually opted out.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch leads whose next action is ready to be processed.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls where the callerID was a duplicate against the Traffic Source’s conversion settings.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls where the Traffic Source had a repeat caller.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch leads that are opted out.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls placed outbound by an agent.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWas the call placed on hold?
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch records where the provider has SMS enabled.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that used a Number Pool.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls that were transferred.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls where the upstream Number could not be determined.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMatch calls with this many Buyer conversions.
\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":"\nMatch leads with this dial tier (priority) value.
\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":"\nMatch calls with this many off-hook find-a-buyer attempts.
\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":"\nMatch calls with this many Traffic Source conversions.
\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":"\nMatch records with this HTTP response status code.
\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":"\nMatch calls where this Buyer was attempted.
\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":"\nMatch calls where the Buyer belongs to one of these Buyer Groups.
\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":"\nMatch calls where this Buyer was the winning Buyer.
\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":"\nMatch calls suppressed by this Buyer Suppression list.
\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":"\nMatch calls handled by this Call Center.
\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":"\nMatch records generated by this Inbound Webhook.
\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":"\nMatch leads imported from this Lead Import.
\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":"\nMatch calls placed to this Number.
\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":"\nMatch calls off-hook to this Buyer.
\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":"\nMatch records belonging to this Offer.
\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":"\nMatch calls routed through this Provider Configuration.
\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":"\nMatch calls where this Buyer was used for quality assurance monitoring.
\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":"\nMatch leads whose most recent call has this Call Disposition.
\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":"\nMatch calls referred from this Call id.
\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":"\nMatch calls referred from this Number id.
\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":"\nMatch calls referred from this Offer id.
\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":"\nMatch calls referred from this Schedule id.
\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":"\nMatch calls placed through this Number Pool.
\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":"\nMatch records belonging to this Schedule.
\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":"\nMatch records from this SMS Blast.
\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":"\nMatch records tagged with this Token.
\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":"\nMatch records tagged with this Token Value.
\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":"\nRefer to the traffic source api for details
\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":"\nGroup results by this field, when data_type is call (e.g. buyer_id, offer_id, status).
\n","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":"\nMatch records with this code.
\n","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":"\nMatch records tagged with this Custom Contact Field Type.
\n","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":"\nMatch records from this country.
\n","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":"\nMatch records created through this source.
\n","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":"\nMatch calls with this direction (e.g. inbound or outbound).
\n","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":"\nMatch calls with this hangup cause status.
\n","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":"\nMatch calls hung up by this source.
\n","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":"\nMatch calls hung up by this party.
\n","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":"\nMatch calls with this off-hook type.
\n","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":"\nMatch leads owned by this type of record (Offer or Schedule).
\n","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":"\nMatch records submitted from this IP address.
\n","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":"\nMatch records submitted with this HTTP method.
\n","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":"\nOnly include leads whose schedule ended within this named timeframe.
\n","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":"\nMatch leads whose end of schedule trigger matches this type.
\n","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":"\nMatch records with this status value.
\n","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":"\nMatch records from this state or province.
\n","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":"\nMatch records with this sub id.
\n","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":"\nCalls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.
\n","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":"\nWill 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.
\n","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":"\nSearch for any record that matches this text
\n","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":"\nOnly include leads whose most recent call was on or after this time.
\n","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":"\nOnly include leads whose most recent call was on or before this time.
\n","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":"\nOnly include leads whose optimizer results were displayed on or after this time.
\n","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":"\nOnly include leads whose optimizer tokens changed on or after this time.
\n","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":"\nOnly include leads whose schedule ended on or after this time.
\n","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":"\nOnly include leads whose schedule ended on or before this time.
\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":"\nThe 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 metadata.next_cursor. 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.
\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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate ranges will be parsed using this time zone.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The unique identifier for this endpoint.
\n","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":"\nAuthorize requests using your token. Get it from your profile: trackdrive.com/profile/edit
\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":"\nPOST with a ping_id to retrieve a tracking number for forwarding an inbound call to a matching buyer.
\n","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\nThe unique identifier for this endpoint.
\n","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":"\nPing ID
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The unique identifier for this endpoint.
\n","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":"\nOffer
\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":"\nName
\n","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":"\nDescription
\n","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":"\nWebhook Type
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:check_for_available_instant_agent, check_for_available_buyer, fire_webhooks.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_ids","full_name":"call_router_ids","description":"\nCall Router Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\nBuyer Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\nBuyer Group Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_body","full_name":"response_body","description":"\nResponse Body
\n","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":"\nRequire a traffic_source_id on every ping and post to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequire a caller_id on every ping to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequire a valid developer access token on every ping and post to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow a forwarding number is provided when a buyer is available, such as a number from a Number Pool or the caller’s own number.
\n","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":"\nThe Number Pool a tracking number is assigned from when tracking_type uses a Number Pool.
\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":"\nWhen enabled, calls and leads sent to this endpoint are processed without being delivered to buyers, so it can be tested safely.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAlso search buyers that were dynamically assigned to the offer, not only the buyers and buyer groups selected here.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe maximum number of available buyers to return on a ping.
\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":"\nHow many seconds to wait for a response before timing out the request.
\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":"\nPercentage buffer applied to buyer concurrency caps when checking for available buyers.
\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":"\nAppend additional data to leads created through this endpoint using a Data Append Group.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Data Append Group used to append additional data to leads created through this endpoint.
\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":"\nMaximum number of requests this endpoint will accept per minute, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per hour, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per day, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per minute, per traffic source.
\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":"\nMaximum number of requests this endpoint will accept per hour, per traffic source.
\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":"\nMaximum number of requests this endpoint will accept per day, per traffic source.
\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":"\nA Traffic Source Rate Limiter used to apply shared rate limits across multiple traffic sources.
\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":"\nThe response fields to include for each buyer when responding to a ping.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_post_column_names","full_name":"buyer_post_column_names","description":"\nThe response fields to include when responding to a post.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\nMake this endpoint’s posting instructions viewable on a public, unauthenticated page.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nList this endpoint on the public index page of your account’s published posting instructions.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe name shown for this endpoint on its public posting instructions page.
\n","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":"\nThe description shown for this endpoint on its public posting instructions page.
\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":"\nThe unique identifier for this endpoint.
\n","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":"\nOffer
\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":"\nName
\n","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":"\nDescription
\n","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":"\nWebhook Type
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:check_for_available_instant_agent, check_for_available_buyer, fire_webhooks.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_ids","full_name":"call_router_ids","description":"\nCall Router Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\nBuyer Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\nBuyer Group Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_body","full_name":"response_body","description":"\nResponse Body
\n","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":"\nRequire a traffic_source_id on every ping and post to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequire a caller_id on every ping to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequire a valid developer access token on every ping and post to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow a forwarding number is provided when a buyer is available, such as a number from a Number Pool or the caller’s own number.
\n","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":"\nThe Number Pool a tracking number is assigned from when tracking_type uses a Number Pool.
\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":"\nWhen enabled, calls and leads sent to this endpoint are processed without being delivered to buyers, so it can be tested safely.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAlso search buyers that were dynamically assigned to the offer, not only the buyers and buyer groups selected here.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe maximum number of available buyers to return on a ping.
\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":"\nHow many seconds to wait for a response before timing out the request.
\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":"\nPercentage buffer applied to buyer concurrency caps when checking for available buyers.
\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":"\nAppend additional data to leads created through this endpoint using a Data Append Group.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Data Append Group used to append additional data to leads created through this endpoint.
\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":"\nMaximum number of requests this endpoint will accept per minute, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per hour, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per day, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per minute, per traffic source.
\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":"\nMaximum number of requests this endpoint will accept per hour, per traffic source.
\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":"\nMaximum number of requests this endpoint will accept per day, per traffic source.
\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":"\nA Traffic Source Rate Limiter used to apply shared rate limits across multiple traffic sources.
\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":"\nThe response fields to include for each buyer when responding to a ping.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_post_column_names","full_name":"buyer_post_column_names","description":"\nThe response fields to include when responding to a post.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\nMake this endpoint’s posting instructions viewable on a public, unauthenticated page.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nList this endpoint on the public index page of your account’s published posting instructions.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe name shown for this endpoint on its public posting instructions page.
\n","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":"\nThe description shown for this endpoint on its public posting instructions page.
\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":"\nThe unique identifier for this endpoint.
\n","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":"\nOffer
\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":"\nName
\n","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":"\nDescription
\n","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":"\nWebhook Type
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:check_for_available_instant_agent, check_for_available_buyer, fire_webhooks.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_ids","full_name":"call_router_ids","description":"\nCall Router Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\nBuyer Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\nBuyer Group Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_body","full_name":"response_body","description":"\nResponse Body
\n","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":"\nRequire a traffic_source_id on every ping and post to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequire a caller_id on every ping to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRequire a valid developer access token on every ping and post to this endpoint.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow a forwarding number is provided when a buyer is available, such as a number from a Number Pool or the caller’s own number.
\n","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":"\nThe Number Pool a tracking number is assigned from when tracking_type uses a Number Pool.
\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":"\nWhen enabled, calls and leads sent to this endpoint are processed without being delivered to buyers, so it can be tested safely.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAlso search buyers that were dynamically assigned to the offer, not only the buyers and buyer groups selected here.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe maximum number of available buyers to return on a ping.
\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":"\nHow many seconds to wait for a response before timing out the request.
\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":"\nPercentage buffer applied to buyer concurrency caps when checking for available buyers.
\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":"\nAppend additional data to leads created through this endpoint using a Data Append Group.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Data Append Group used to append additional data to leads created through this endpoint.
\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":"\nMaximum number of requests this endpoint will accept per minute, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per hour, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per day, across all traffic sources.
\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":"\nMaximum number of requests this endpoint will accept per minute, per traffic source.
\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":"\nMaximum number of requests this endpoint will accept per hour, per traffic source.
\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":"\nMaximum number of requests this endpoint will accept per day, per traffic source.
\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":"\nA Traffic Source Rate Limiter used to apply shared rate limits across multiple traffic sources.
\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":"\nThe response fields to include for each buyer when responding to a ping.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_post_column_names","full_name":"buyer_post_column_names","description":"\nThe response fields to include when responding to a post.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\nMake this endpoint’s posting instructions viewable on a public, unauthenticated page.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nList this endpoint on the public index page of your account’s published posting instructions.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe name shown for this endpoint on its public posting instructions page.
\n","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":"\nThe description shown for this endpoint on its public posting instructions page.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Enable or disable an integration object.
\n","required":false,"allow_nil":false,"allow_blank":false,"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":"\nIntegration Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:blacklist_alliance, eleven_labs, facebook_capi, facebook_leadads, google_adwords, infusionsoft, mailchimp, mailgun, pagerduty, salesforce, sendgrid, slack, snapchat_capi, tcpa_shield, typeform, zadarma, zoho_crm.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nA friendly name for this integration, shown when managing your integrations.
\n","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":"\nA note describing what this integration is used for.
\n","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":"\nThe public API key issued by the connected service, used to authenticate requests to it.
\n","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":"\nThe secret API key issued by the connected service, used to authenticate requests to it.
\n","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":"\nThe integration key (routing key) from your PagerDuty service, used to send it alerts.
\n","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":"\nThe incoming webhook URL from your Slack workspace, used to post messages to it.
\n","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":"\nThe number of seconds a lookup result from this integration is cached before it is requested again.
\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":"\nWhen true, this integration fires for every matching event instead of only events matching its trigger fields.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nIntegration Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:blacklist_alliance, eleven_labs, facebook_capi, facebook_leadads, google_adwords, infusionsoft, mailchimp, mailgun, pagerduty, salesforce, sendgrid, slack, snapchat_capi, tcpa_shield, typeform, zadarma, zoho_crm.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nA friendly name for this integration, shown when managing your integrations.
\n","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":"\nA note describing what this integration is used for.
\n","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":"\nThe public API key issued by the connected service, used to authenticate requests to it.
\n","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":"\nThe secret API key issued by the connected service, used to authenticate requests to it.
\n","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":"\nThe integration key (routing key) from your PagerDuty service, used to send it alerts.
\n","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":"\nThe incoming webhook URL from your Slack workspace, used to post messages to it.
\n","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":"\nThe number of seconds a lookup result from this integration is cached before it is requested again.
\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":"\nWhen true, this integration fires for every matching event instead of only events matching its trigger fields.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nIntegration Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:blacklist_alliance, eleven_labs, facebook_capi, facebook_leadads, google_adwords, infusionsoft, mailchimp, mailgun, pagerduty, salesforce, sendgrid, slack, snapchat_capi, tcpa_shield, typeform, zadarma, zoho_crm.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nA friendly name for this integration, shown when managing your integrations.
\n","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":"\nA note describing what this integration is used for.
\n","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":"\nThe public API key issued by the connected service, used to authenticate requests to it.
\n","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":"\nThe secret API key issued by the connected service, used to authenticate requests to it.
\n","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":"\nThe integration key (routing key) from your PagerDuty service, used to send it alerts.
\n","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":"\nThe incoming webhook URL from your Slack workspace, used to post messages to it.
\n","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":"\nThe number of seconds a lookup result from this integration is cached before it is requested again.
\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":"\nWhen true, this integration fires for every matching event instead of only events matching its trigger fields.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\n","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":"\nIf the caller doesn’t press a key, use the flow configured for no key press instead.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nName
\n","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":"\nDescription
\n","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":"\nIf the caller doesn’t press a key, use the flow configured for no key press instead.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nName
\n","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":"\nDescription
\n","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":"\nIf the caller doesn’t press a key, use the flow configured for no key press instead.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Key Press Flow Group
\n","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":"\nKey Press
\n","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":"\nDescription
\n","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":"\nWhen 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe disposition applied to the call when this key is pressed, instead of ending the call routing search.
\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":"\nThe actions to run when this key is pressed, instead of ending the call routing search.
\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":"\nOnly allows this key press once the buyer has been connected for at least this many seconds.
\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":"\nOnly uses this Key Press Flow for calls matching these token values.
\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":"\nWhen this Key Press Flow’s actions run, the call will be tagged with these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nKey Press Flow Group
\n","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":"\nKey Press
\n","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":"\nDescription
\n","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":"\nWhen 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe disposition applied to the call when this key is pressed, instead of ending the call routing search.
\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":"\nThe actions to run when this key is pressed, instead of ending the call routing search.
\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":"\nOnly allows this key press once the buyer has been connected for at least this many seconds.
\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":"\nOnly uses this Key Press Flow for calls matching these token values.
\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":"\nWhen this Key Press Flow’s actions run, the call will be tagged with these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nKey Press Flow Group
\n","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":"\nKey Press
\n","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":"\nDescription
\n","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":"\nWhen 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe disposition applied to the call when this key is pressed, instead of ending the call routing search.
\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":"\nThe actions to run when this key is pressed, instead of ending the call routing search.
\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":"\nOnly allows this key press once the buyer has been connected for at least this many seconds.
\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":"\nOnly uses this Key Press Flow for calls matching these token values.
\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":"\nWhen this Key Press Flow’s actions run, the call will be tagged with these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
How 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. [
\n\n{ "td_key": "caller_id", "ex_key": "Phone", "import": "1" },\n{ "td_key": "email", "ex_key": "Email", "import": "1" }\n\n]
\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":"\nHow 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. [
\n\n{ "td_key": "caller_id", "ex_key": "Phone", "import": "1" },\n{ "td_key": "email", "ex_key": "Email", "import": "1" }\n\n]
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Description
\n","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":"\nLead Import
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nThe name of this retarget, shown in your retarget list.
\n","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":"\nPause or unpause this retarget. A paused retarget will not process leads.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhere to pull leads from: lead_import to retarget leads from an uploaded Lead Import, or schedule to retarget leads currently on a Schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:lead_import, schedule.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_schedule_id","full_name":"data_source_schedule_id","description":"\nThe Schedule to pull leads from, when data_source_type is schedule.
\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":"\nOnly include leads created on or after this time, when data_source_type is schedule.
\n","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":"\nOnly include leads created on or before this time, when data_source_type is schedule.
\n","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":"\nOnly include leads owned by this type of record (Offer or Schedule), when data_source_type is schedule.
\n","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":"\nOnly include leads whose end of schedule trigger matches this type, when data_source_type is schedule.
\n","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":"\nOnly include leads attributed to this Traffic Source.
\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":"\nWhether this retarget’s filter step has been completed. Must be true, along with form_step_actions_complete, for the retarget to run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhether this retarget’s actions step has been completed. Must be true, along with form_step_filter_complete, for the retarget to run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAdd matching leads to add_to_schedule_id after this retarget’s actions run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Schedule to add matching leads to, when add_to_schedule_enabled is true.
\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":"\nExclude leads that are currently live (on an active call) from this retarget.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nExclude leads whose contact has opted out from this retarget.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nExclude leads with a call that was attempted to a Buyer within the scrub_buyer_attempted_from/scrub_buyer_attempted_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_attempted.
\n","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":"\nThe end of the window used by scrub_buyer_attempted.
\n","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":"\nExclude leads with a call that connected to a Buyer within the scrub_buyer_connected_from/scrub_buyer_connected_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_connected.
\n","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":"\nThe end of the window used by scrub_buyer_connected.
\n","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":"\nExclude leads with a call that converted for a Buyer within the scrub_buyer_converted_from/scrub_buyer_converted_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_converted.
\n","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":"\nThe end of the window used by scrub_buyer_converted.
\n","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":"\nExclude leads with a call matching any of these Call Dispositions within the scrub_call_disposition_ids_from/scrub_call_disposition_ids_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_from","full_name":"scrub_call_disposition_ids_from","description":"\nThe start of the window used by scrub_call_disposition_ids.
\n","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":"\nThe end of the window used by scrub_call_disposition_ids.
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nDescription
\n","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":"\nLead Import
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nThe name of this retarget, shown in your retarget list.
\n","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":"\nPause or unpause this retarget. A paused retarget will not process leads.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhere to pull leads from: lead_import to retarget leads from an uploaded Lead Import, or schedule to retarget leads currently on a Schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:lead_import, schedule.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_schedule_id","full_name":"data_source_schedule_id","description":"\nThe Schedule to pull leads from, when data_source_type is schedule.
\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":"\nOnly include leads created on or after this time, when data_source_type is schedule.
\n","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":"\nOnly include leads created on or before this time, when data_source_type is schedule.
\n","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":"\nOnly include leads owned by this type of record (Offer or Schedule), when data_source_type is schedule.
\n","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":"\nOnly include leads whose end of schedule trigger matches this type, when data_source_type is schedule.
\n","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":"\nOnly include leads attributed to this Traffic Source.
\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":"\nWhether this retarget’s filter step has been completed. Must be true, along with form_step_actions_complete, for the retarget to run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhether this retarget’s actions step has been completed. Must be true, along with form_step_filter_complete, for the retarget to run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAdd matching leads to add_to_schedule_id after this retarget’s actions run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Schedule to add matching leads to, when add_to_schedule_enabled is true.
\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":"\nExclude leads that are currently live (on an active call) from this retarget.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nExclude leads whose contact has opted out from this retarget.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nExclude leads with a call that was attempted to a Buyer within the scrub_buyer_attempted_from/scrub_buyer_attempted_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_attempted.
\n","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":"\nThe end of the window used by scrub_buyer_attempted.
\n","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":"\nExclude leads with a call that connected to a Buyer within the scrub_buyer_connected_from/scrub_buyer_connected_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_connected.
\n","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":"\nThe end of the window used by scrub_buyer_connected.
\n","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":"\nExclude leads with a call that converted for a Buyer within the scrub_buyer_converted_from/scrub_buyer_converted_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_converted.
\n","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":"\nThe end of the window used by scrub_buyer_converted.
\n","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":"\nExclude leads with a call matching any of these Call Dispositions within the scrub_call_disposition_ids_from/scrub_call_disposition_ids_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_from","full_name":"scrub_call_disposition_ids_from","description":"\nThe start of the window used by scrub_call_disposition_ids.
\n","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":"\nThe end of the window used by scrub_call_disposition_ids.
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nDescription
\n","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":"\nLead Import
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nThe name of this retarget, shown in your retarget list.
\n","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":"\nPause or unpause this retarget. A paused retarget will not process leads.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhere to pull leads from: lead_import to retarget leads from an uploaded Lead Import, or schedule to retarget leads currently on a Schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:lead_import, schedule.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_source_schedule_id","full_name":"data_source_schedule_id","description":"\nThe Schedule to pull leads from, when data_source_type is schedule.
\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":"\nOnly include leads created on or after this time, when data_source_type is schedule.
\n","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":"\nOnly include leads created on or before this time, when data_source_type is schedule.
\n","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":"\nOnly include leads owned by this type of record (Offer or Schedule), when data_source_type is schedule.
\n","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":"\nOnly include leads whose end of schedule trigger matches this type, when data_source_type is schedule.
\n","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":"\nOnly include leads attributed to this Traffic Source.
\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":"\nWhether this retarget’s filter step has been completed. Must be true, along with form_step_actions_complete, for the retarget to run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhether this retarget’s actions step has been completed. Must be true, along with form_step_filter_complete, for the retarget to run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAdd matching leads to add_to_schedule_id after this retarget’s actions run.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Schedule to add matching leads to, when add_to_schedule_enabled is true.
\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":"\nExclude leads that are currently live (on an active call) from this retarget.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nExclude leads whose contact has opted out from this retarget.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nExclude leads with a call that was attempted to a Buyer within the scrub_buyer_attempted_from/scrub_buyer_attempted_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_attempted.
\n","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":"\nThe end of the window used by scrub_buyer_attempted.
\n","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":"\nExclude leads with a call that connected to a Buyer within the scrub_buyer_connected_from/scrub_buyer_connected_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_connected.
\n","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":"\nThe end of the window used by scrub_buyer_connected.
\n","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":"\nExclude leads with a call that converted for a Buyer within the scrub_buyer_converted_from/scrub_buyer_converted_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe start of the window used by scrub_buyer_converted.
\n","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":"\nThe end of the window used by scrub_buyer_converted.
\n","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":"\nExclude leads with a call matching any of these Call Dispositions within the scrub_call_disposition_ids_from/scrub_call_disposition_ids_to window.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"scrub_call_disposition_ids_from","full_name":"scrub_call_disposition_ids_from","description":"\nThe start of the window used by scrub_call_disposition_ids.
\n","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":"\nThe end of the window used by scrub_call_disposition_ids.
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nLead Wait Rule Ids
\n","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":"\nDescription
\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":"\nName
\n","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":"\nLead Wait Rule Ids
\n","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":"\nDescription
\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":"\nName
\n","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":"\nLead Wait Rule Ids
\n","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":"\nDescription
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nWait Seconds
\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":"\nDescription
\n","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":"\nCall Dispositions
\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":"\nCall Dispositions Two Calls Ago
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRecord Token Filter Two
\n","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":"\nToken Value Two Ids
\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":"\nThe order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first.
\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":"\nAssign this rule to these Wait Rule Groups.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_list","full_name":"record_token_filter_two_list","description":"\nAssign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nName
\n","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":"\nWait Seconds
\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":"\nDescription
\n","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":"\nCall Dispositions
\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":"\nCall Dispositions Two Calls Ago
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRecord Token Filter Two
\n","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":"\nToken Value Two Ids
\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":"\nThe order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first.
\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":"\nAssign this rule to these Wait Rule Groups.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_list","full_name":"record_token_filter_two_list","description":"\nAssign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nName
\n","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":"\nWait Seconds
\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":"\nDescription
\n","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":"\nCall Dispositions
\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":"\nCall Dispositions Two Calls Ago
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRecord Token Filter Two
\n","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":"\nToken Value Two Ids
\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":"\nThe order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first.
\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":"\nAssign this rule to these Wait Rule Groups.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_two_list","full_name":"record_token_filter_two_list","description":"\nAssign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| lead | Lead |
| lead_grid | Lead Grid |
| lead_external | Lead External |
Return the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Dynamic Date String such as “Today” or “This Year”
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:Last 5 Min, Last 15 Min, Last 30 Min, Last Hour, Last 4 Hours, Last 6 Hours, Last 12 Hours, Last Day, Last 2 Days, Today, Yesterday, This Week, Last Week, This Month, Last Month, This Quarter, Last Quarter, Last 6 Months, This Year, Last Year, Lifetime, Custom Range.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_action_at_to","full_name":"next_action_at_to","description":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nRefer to the offer api for details
\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":"\nSchedule internal id.
\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":"\nMatch calls that were placed by this caller.
\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":"\nRefer to the traffic source api for details
\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":"\nRefer to the buyer api for details
\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":"\nMatch results that have this status.
\n","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":"\nFilter for leads that are waiting before performing an action.
\n","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":"\nThe 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.
\n","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":"\nThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.
\n","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":"\nFilter for leads that have more actions to perform.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nSelect leads that have converted.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nSelect leads where a traffic source converted.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nSelect leads where either a buyer or traffic source converted.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nSelect leads that have opted-out.
\n","required":false,"allow_nil":false,"allow_blank":false,"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":"\nCheck if a lead has a potential buyer available that matches the lead’s filters.
\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":"\nThe 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.
\n","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":"\nFind the lead by this caller number.
\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":"\nPass an ID belonging to an Agent Script & Field Type to select that Custom Contact Field Type for this call.
The callerID for the lead. This is the number Trackdrive will dial when making outbound calls to the lead. This is also the number where Trackdrive will send SMS.
\n","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":"\nThe 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.
\n","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":"\nSet 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.
\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":"\nSelect leads that have opted-out.
\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":"\nThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.
\n","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":"\nUpdate the traffic source associated with this lead.
\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":"\nReassign 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.
\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":"\nReassign 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.
\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":"\nFor 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.
\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":"\nChange 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.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:20 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_at","full_name":"schedule_callback_at","description":"\nSchedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:20 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\nSchedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600
\n","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":"\nAdds the lead back into the Schedule. Remaining actions will be performed.
\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":"\nRemoves the lead from the Schedule. No further actions will be taken.
\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":"\nWhen true, restarts the lead’s schedule from the beginning.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, marks the lead as opted-in, allowing outbound actions (calls, SMS, emails) to resume.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, marks the lead as opted-out, preventing outbound actions (calls, SMS, emails).
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nPlace an outbound call to the lead this many seconds from now. Use 0 to place the call immediately.
Move To Another Schedule - Assign matching leads to the selected schedule. Lead’s already on the selected schedule will restart their schedule.
\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":"\nShould the data you’re sending also be applied to calls associated with this lead?
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:calls, self.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"\nTrackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'} 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}}”
Group or pivot the report by one of these lead attributes.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| status | Status |
| offer_id | Offer |
| schedule_id | Schedule |
| schedule_action_id | Schedule Action |
| buyer_converted_schedule_action_id | The schedule action where the lead converted. |
| lead_import_id | Lead Import |
| traffic_source_id | Traffic Source |
| outbound_calls_count | Outbound Calls Count |
| inbound_calls_count | Inbound Calls Count |
| recent_call_disposition_id | Recent Call Disposition |
| buyer_converted_days | Buyer Converted Days |
| buyer_id | Buyer |
| country | Country |
| call_center_id | Call Center |
| state | State |
| sub_id | Sub ID |
| dial_tier | Dial Tier |
| contact_field_type | Contact Field Type |
| created_at_day | The day the lead was submitted |
| created_at_month | The month the lead was submitted |
| created_at_week | The week the lead was submitted |
| created_at_five_minutes | The minute the lead was submitted |
| created_at_hour | The hour lead was submitted |
| schedule_trigger_type | Schedule Trigger Type |
| zip_postal_code | Zip/Postal Code |
| country | Country |
| state_province | State/Province |
| token_values_map | Token Values Map |
Group or pivot the report by one of these lead attributes.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| status | Status |
| offer_id | Offer |
| schedule_id | Schedule |
| schedule_action_id | Schedule Action |
| buyer_converted_schedule_action_id | The schedule action where the lead converted. |
| lead_import_id | Lead Import |
| traffic_source_id | Traffic Source |
| outbound_calls_count | Outbound Calls Count |
| inbound_calls_count | Inbound Calls Count |
| recent_call_disposition_id | Recent Call Disposition |
| buyer_converted_days | Buyer Converted Days |
| buyer_id | Buyer |
| country | Country |
| call_center_id | Call Center |
| state | State |
| sub_id | Sub ID |
| dial_tier | Dial Tier |
| contact_field_type | Contact Field Type |
| created_at_day | The day the lead was submitted |
| created_at_month | The month the lead was submitted |
| created_at_week | The week the lead was submitted |
| created_at_five_minutes | The minute the lead was submitted |
| created_at_hour | The hour lead was submitted |
| schedule_trigger_type | Schedule Trigger Type |
| zip_postal_code | Zip/Postal Code |
| country | Country |
| state_province | State/Province |
| token_values_map | Token Values Map |
Return the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.
\n","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":"\nThe 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.
\n","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":"\nThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.
\n","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":"\nPass an ID belonging to an Agent Script & Field Type to select that Custom Contact Field Type for this call.
Schedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:20 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\nSchedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600
\n","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":"\nIf 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)
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nShould the data you’re sending also be applied to calls associated with this lead?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:calls.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unblock_contact","full_name":"unblock_contact","description":"\nRemove the caller_id from the company blacklist. Usage of this param requires passing an auth_token with permission to update Leads.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nSet 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.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nAssign a dialing number and return it in the API response as trackdrive_number_plain
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nAssign an SMS number and return it in the API response as sms_number_plain
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nExpire existing live schedule leads that match the lead_token and caller_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDelete existing leads that match the lead_token and caller_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nOnly 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.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDefines 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.
\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":"\nRestart the schedule for the lead from the beginning.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nAutomatically extract contact fields that are nested inside non-standard incoming POST.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nChange 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.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:20 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hours_to_expire","full_name":"hours_to_expire","description":"\nExpire the lead after this many hours. The lead will exit schedule and perform end of schedule actions.
\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":"\nExpire the lead after this many outbound calls + SMS. The lead will exit schedule and perform end of schedule actions.
\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":"\nTrackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'} 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}}”
The traffic source this lead came from, as its Trackdrive id or the traffic source id you gave it (user_traffic_source_id).
\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":"\nMark 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.
\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":"\nWhether this caller has given permission to be contacted, as required by your compliance settings.
\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":"\nCreate a new lead if no active lead exists on the offer, or update the existing active lead.
\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\nThe 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.
\n","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":"\nThe 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.
\n","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":"\nThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.
\n","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":"\nPass an ID belonging to an Agent Script & Field Type to select that Custom Contact Field Type for this call.
Schedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:20 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\nSchedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600
\n","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":"\nIf 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)
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nShould the data you’re sending also be applied to calls associated with this lead?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:calls.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_trackdrive_number","full_name":"assign_trackdrive_number","description":"\nAssign a dialing number and return it in the API response as trackdrive_number_plain
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nAssign an SMS number and return it in the API response as sms_number_plain
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDefines 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.
\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":"\nRestart the schedule for the lead from the beginning.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nAutomatically extract contact fields that are nested inside non-standard incoming POST.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nChange 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.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:20 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hours_to_expire","full_name":"hours_to_expire","description":"\nExpire the lead after this many hours. The lead will exit schedule and perform end of schedule actions.
\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":"\nExpire the lead after this many outbound calls + SMS. The lead will exit schedule and perform end of schedule actions.
\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":"\nTrackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'} 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}}”
The traffic source this lead came from, as its Trackdrive id or the traffic source id you gave it (user_traffic_source_id).
\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":"\nMark 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.
\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":"\nWhether this caller has given permission to be contacted, as required by your compliance settings.
\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":"\nMark a single lead as opt-out. Opted-out leads will no longer be sent SMS, Calls, or Emails.
\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\nThe 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.
\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":"\nRemove a single lead from a Schedule or Offer. This will prevent ANY additional actions being taken on behalf of the lead.
\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\nThe 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.
\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":"\nThe 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.
\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":"\nUpdate one specific lead by its Trackdrive lead id. Unlike the caller_id endpoints, only the lead you name is changed.
\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\nThe 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.
\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":"\nThe 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.
\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":"\nThe email address for the lead. The lead’s email is required for sending emails from schedules to leads.
\n","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":"\nPass an ID belonging to an Agent Script & Field Type to select that Custom Contact Field Type for this call.
Schedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:20 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_callback_in_seconds","full_name":"schedule_callback_in_seconds","description":"\nSchedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600
\n","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":"\nIf 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)
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nShould the data you’re sending also be applied to calls associated with this lead?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:calls.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unblock_contact","full_name":"unblock_contact","description":"\nRemove the caller_id from the company blacklist. Usage of this param requires passing an auth_token with permission to update Leads.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nSet 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.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nAssign a dialing number and return it in the API response as trackdrive_number_plain
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nAssign an SMS number and return it in the API response as sms_number_plain
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDefines 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.
\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":"\nRestart the schedule for the lead from the beginning.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nAutomatically extract contact fields that are nested inside non-standard incoming POST.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nChange 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.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:20 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hours_to_expire","full_name":"hours_to_expire","description":"\nExpire the lead after this many hours. The lead will exit schedule and perform end of schedule actions.
\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":"\nExpire the lead after this many outbound calls + SMS. The lead will exit schedule and perform end of schedule actions.
\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":"\nTrackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'} 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}}”
The traffic source this lead came from, as its Trackdrive id or the traffic source id you gave it (user_traffic_source_id).
\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":"\nMark 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.
\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":"\nWhether this caller has given permission to be contacted, as required by your compliance settings.
\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":"\nMark 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.
\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\nThe 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.
\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":"\nThe 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.
\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&lead_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":"\nRemove 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.
\n","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\nThe 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.
\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":"\nThe 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.
\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":"\nThe 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.
\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":"\nThe 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.
\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":"\nList the mitigation numbers in your account. Each row includes the per-carrier reputation reported by T-Mobile, Verizon, and AT&T (displayed caller ID and whether the number is currently spam-flagged), the branded name, and the carrier approval status.
\n","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Enable or disable spam-tag mitigation, or set the branded name, for a number.
\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\nThe id of the mitigation number to update.
\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":"\nWhether 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.
\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":"\nThe business name shown as branded caller ID. Calls placed from a number with a branded name are billed per call.
\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":"\nRemove 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.
\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\nThe id of the mitigation number to update.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Number Order
\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":"\nPrefix
\n","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":"\nOrder Count
\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":"\nSortable Order
\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":"\nNumber Order
\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":"\nPrefix
\n","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":"\nOrder Count
\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":"\nSortable Order
\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":"\nNumber Order
\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":"\nPrefix
\n","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":"\nOrder Count
\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":"\nSortable Order
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The offer the ordered numbers will be assigned to.
\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":"\nThe number pool the ordered numbers will be added to.
\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":"\nThe traffic source the ordered numbers will be assigned to.
\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":"\nThe schedule the ordered numbers will be assigned to.
\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":"\nThe name of the number order.
\n","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":"\nA description of the number order.
\n","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":"\nThe provider the numbers will be purchased from.
\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":"\nPause the order so it stops purchasing numbers.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen no number is available with the requested prefix, allow purchasing any available number in the same state.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nThe offer the ordered numbers will be assigned to.
\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":"\nThe number pool the ordered numbers will be added to.
\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":"\nThe traffic source the ordered numbers will be assigned to.
\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":"\nThe schedule the ordered numbers will be assigned to.
\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":"\nThe name of the number order.
\n","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":"\nA description of the number order.
\n","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":"\nThe provider the numbers will be purchased from.
\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":"\nPause the order so it stops purchasing numbers.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen no number is available with the requested prefix, allow purchasing any available number in the same state.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nThe offer the ordered numbers will be assigned to.
\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":"\nThe number pool the ordered numbers will be added to.
\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":"\nThe traffic source the ordered numbers will be assigned to.
\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":"\nThe schedule the ordered numbers will be assigned to.
\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":"\nThe name of the number order.
\n","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":"\nA description of the number order.
\n","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":"\nThe provider the numbers will be purchased from.
\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":"\nPause the order so it stops purchasing numbers.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen no number is available with the requested prefix, allow purchasing any available number in the same state.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The offer this AMD Flow belongs to.
\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":"\nA description of the AMD Flow.
\n","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":"\nOnly apply this AMD Flow to calls matching these filters.
\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":"\nOnly apply this AMD Flow to calls matching these tokens.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\nIf Classification Matches
\n","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":"\nOr if Speech To Text Matches
\n","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":"\nThen 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.
\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":"\nThe offer this AMD Flow belongs to.
\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":"\nA description of the AMD Flow.
\n","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":"\nOnly apply this AMD Flow to calls matching these filters.
\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":"\nOnly apply this AMD Flow to calls matching these tokens.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\nIf Classification Matches
\n","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":"\nOr if Speech To Text Matches
\n","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":"\nThen 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.
\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":"\nThe offer this AMD Flow belongs to.
\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":"\nA description of the AMD Flow.
\n","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":"\nOnly apply this AMD Flow to calls matching these filters.
\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":"\nOnly apply this AMD Flow to calls matching these tokens.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\nIf Classification Matches
\n","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":"\nOr if Speech To Text Matches
\n","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":"\nThen 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.
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer_conversion | Default response format. |
| offer_conversion_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
The Offer this conversion rule belongs to.
\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":"\nScopes this conversion rule to calls during this Business Range, instead of the whole Offer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days & Hours}[/api/docs/1.0//index.html]. Refer to: {/api/docs/1.0/}[/api/docs/1.0//index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer_conversion | Default response format. |
| offer_conversion_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer_conversion | Default response format. |
| offer_conversion_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer_conversion | Default response format. |
| offer_conversion_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Payout Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:usd, buyer_conversion_percent.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payout","full_name":"payout","description":"\nPayout
\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":"\nRevenue Percentage
\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":"\nDuration
\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":"\nDuplicate Timeframe
\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":"\nDuplicate Timeframe Scope
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:offer, traffic_source, number.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\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":"\nThe Offer this conversion rule belongs to.
\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":"\nScopes this conversion rule to calls during this Business Range, instead of the whole Offer.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days & Hours}[/api/docs/1.0//index.html]. Refer to: {/api/docs/1.0/}[/api/docs/1.0//index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"conversion_type","full_name":"conversion_type","description":"\nWhen the traffic source is paid: payout (after Duration seconds), postback (an external conversion postback), or when_buyer_converted (when a buyer converts the call).
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:payout, postback, when_buyer_converted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\nScopes this conversion rule to calls from this Traffic Source, instead of the whole Offer.
\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":"\nScopes this conversion rule to calls to this Number, instead of the whole Offer.
\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":"\nThe id of the record given in owner_type that this conversion rule is scoped to, instead of the whole Offer.
\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":"\nWhat this conversion rule is scoped to instead of the whole Offer: TrafficSource, Number, or BusinessRange, used together with owner_id.
\n","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":"\nOnly pays out for calls matching these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\nSortable Order
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer_conversion | Default response format. |
| offer_conversion_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Payout Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:usd, buyer_conversion_percent.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payout","full_name":"payout","description":"\nPayout
\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":"\nRevenue Percentage
\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":"\nDuration
\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":"\nDuplicate Timeframe
\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":"\nDuplicate Timeframe Scope
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:offer, traffic_source, number.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nThe Offer this conversion rule belongs to.
\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":"\nScopes this conversion rule to calls during this Business Range, instead of the whole Offer.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days & Hours}[/api/docs/1.0//index.html]. Refer to: {/api/docs/1.0/}[/api/docs/1.0//index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"conversion_type","full_name":"conversion_type","description":"\nWhen the traffic source is paid: payout (after Duration seconds), postback (an external conversion postback), or when_buyer_converted (when a buyer converts the call).
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:payout, postback, when_buyer_converted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\nScopes this conversion rule to calls from this Traffic Source, instead of the whole Offer.
\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":"\nScopes this conversion rule to calls to this Number, instead of the whole Offer.
\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":"\nThe id of the record given in owner_type that this conversion rule is scoped to, instead of the whole Offer.
\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":"\nWhat this conversion rule is scoped to instead of the whole Offer: TrafficSource, Number, or BusinessRange, used together with owner_id.
\n","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":"\nOnly pays out for calls matching these token values.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\nSortable Order
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer_conversion | Default response format. |
| offer_conversion_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer | Default response format. |
| offer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
| transcription_offer_config | Transcription Offer Config |
Return the next page of results.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:name, schedules_count, numbers_count, buyers_count, agents_count, paused, user_offer_id, calls_count, recent_calls_count, last_call_at, numbers_count, created_at.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\nSort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:asc, desc.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\nSearch for any record that matches this text
\n","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\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer | Default response format. |
| offer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
| transcription_offer_config | Transcription Offer Config |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer | Default response format. |
| offer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
| transcription_offer_config | Transcription Offer Config |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer | Default response format. |
| offer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
| transcription_offer_config | Transcription Offer Config |
Give this offer a name. Example: Insurance Calls
\n","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":"\nGive this offer a unique ID. Example: IC001
\n","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":"\nA human readable description of the record.
\n","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":"\nPause or unpause the offer. Paused offers will reject all calls and disable all schedules.
\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":"\nRecord Calls
\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":"\nRequire the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.
\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":"\nThe Vertical assigned to this offer, used for reporting and Vertical-scoped enrichment.
\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":"\nHow a caller who calls back the same offer is routed. One of normal, force_previous_buyer, or force_new_buyer.
| Acceptable Value | Description |
|---|---|
| normal | Normal |
| force_previous_buyer | Force Previous Buyer |
| force_new_buyer | Force New Buyer |
The number of seconds after a call ends during which a callback is still treated as a repeat call for routing.
\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":"\nThe buyer IDs eligible to receive a reconnected callback. If blank, no buyers are reconnected.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_behaviour","full_name":"callback_reconnect_behaviour","description":"\nThe action taken once the reconnect timeframe has passed, for example force_new_buyer.
When true, calls from anonymous caller IDs are treated as unique calls instead of being matched to a previous call for the duplicate timeframe.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, a call is not sent to a buyer who already converted a call from the same caller within the duplicate timeframe.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, a call is not sent to a buyer who already answered a call from the same caller within the duplicate timeframe.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, leads submitted to this offer must pass the offer’s contact field validations before they are accepted.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, a lead submitted to this offer must include a traffic_source_id.
When true, a lead is rejected if it duplicates an existing lead from the same traffic source.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, only the contact field keys configured on this offer are accepted on lead submission.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe minimum number of digits accepted in an inbound caller’s phone number.
\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":"\nThe maximum number of digits accepted in an inbound caller’s phone number.
\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":"\nThe Map Contact Field Groups applied to leads submitted to this offer.
\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":"\nThe number of months a lead remains active before it is automatically archived and removed from delivery.
\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":"\nWhen true, this offer’s public posting instructions page is reachable at its posting instructions link.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, this offer is listed on the public posting instructions index page.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe title shown on this offer’s public posting instructions page.
\n","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":"\nThe HTML description shown on this offer’s public posting instructions page.
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer | Default response format. |
| offer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
| transcription_offer_config | Transcription Offer Config |
Give this offer a name. Example: Insurance Calls
\n","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":"\nGive this offer a unique ID. Example: IC001
\n","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":"\nA human readable description of the record.
\n","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":"\nPause or unpause the offer. Paused offers will reject all calls and disable all schedules.
\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":"\nRecord Calls
\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":"\nRequire the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.
\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":"\nThe Vertical assigned to this offer, used for reporting and Vertical-scoped enrichment.
\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":"\nHow a caller who calls back the same offer is routed. One of normal, force_previous_buyer, or force_new_buyer.
| Acceptable Value | Description |
|---|---|
| normal | Normal |
| force_previous_buyer | Force Previous Buyer |
| force_new_buyer | Force New Buyer |
The number of seconds after a call ends during which a callback is still treated as a repeat call for routing.
\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":"\nThe buyer IDs eligible to receive a reconnected callback. If blank, no buyers are reconnected.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_behaviour","full_name":"callback_reconnect_behaviour","description":"\nThe action taken once the reconnect timeframe has passed, for example force_new_buyer.
When true, calls from anonymous caller IDs are treated as unique calls instead of being matched to a previous call for the duplicate timeframe.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, a call is not sent to a buyer who already converted a call from the same caller within the duplicate timeframe.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, a call is not sent to a buyer who already answered a call from the same caller within the duplicate timeframe.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, leads submitted to this offer must pass the offer’s contact field validations before they are accepted.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, a lead submitted to this offer must include a traffic_source_id.
When true, a lead is rejected if it duplicates an existing lead from the same traffic source.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, only the contact field keys configured on this offer are accepted on lead submission.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe minimum number of digits accepted in an inbound caller’s phone number.
\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":"\nThe maximum number of digits accepted in an inbound caller’s phone number.
\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":"\nThe Map Contact Field Groups applied to leads submitted to this offer.
\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":"\nThe number of months a lead remains active before it is automatically archived and removed from delivery.
\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":"\nWhen true, this offer’s public posting instructions page is reachable at its posting instructions link.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, this offer is listed on the public posting instructions index page.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe title shown on this offer’s public posting instructions page.
\n","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":"\nThe HTML description shown on this offer’s public posting instructions page.
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| offer | Default response format. |
| offer_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
| transcription_offer_config | Transcription Offer Config |
Filter for urls that are assigned to this webhook.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Assign the record to this Outgoing Webhook.
\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":"\nRemote URL
\n","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":"\nRemote Method
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:get, post, post_body, post_api_v1, put, delete, patch.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_body","full_name":"post_body","description":"\nPOST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: {"revenue":10, "caller_id": "1231231234"}
POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: Content-Type: application/json
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nA friendly name for this webhook URL, shown when managing the webhook.
\n","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":"\nThe number of seconds to wait for the remote server’s response before treating the request as failed. Must be between 3 and 29.
\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":"\nWhen true, on save Trackdrive removes query string parameters from the Remote URL and creates a matching Webhook Param for each one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Ping Parsers applied to this URL’s response, used when its webhook fires before dialing a buyer.
\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":"\nMap lead and call data to custom values by assigning these Token Value Map Groups to this URL.
\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":"\nThe Tokens used with record_token_filter_list to decide whether this URL’s webhook fires for a call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nA comma-separated list of HTTP status codes treated as a successful response, for example 200,201.
The path within the response body checked to confirm the request succeeded, for example result.status.
The value the response body’s webhook_body_success_path must match for the request to be treated as successful.
The number of seconds a successful response is cached and reused for a repeat request instead of contacting the remote server again.
\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":"\nWhen true, a caller is added to a suppression list after enough consecutive failures from this URL.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe number of consecutive failures from this URL before the caller is added to the suppression list.
\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":"\nThe suppression list callers are added to once suppression_failure_threshold consecutive failures occur.
When true, a failed request to this URL is retried.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe maximum number of times a failed request to this URL is retried. Must be between 0 and 10.
\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":"\nThe number of seconds to wait before retrying a failed request to this URL. Must be between 30 and 3600.
\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":"\nAssign the record to this Outgoing Webhook.
\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":"\nRemote URL
\n","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":"\nRemote Method
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:get, post, post_body, post_api_v1, put, delete, patch.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_body","full_name":"post_body","description":"\nPOST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: {"revenue":10, "caller_id": "1231231234"}
POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: Content-Type: application/json
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nA friendly name for this webhook URL, shown when managing the webhook.
\n","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":"\nThe number of seconds to wait for the remote server’s response before treating the request as failed. Must be between 3 and 29.
\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":"\nWhen true, on save Trackdrive removes query string parameters from the Remote URL and creates a matching Webhook Param for each one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Ping Parsers applied to this URL’s response, used when its webhook fires before dialing a buyer.
\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":"\nMap lead and call data to custom values by assigning these Token Value Map Groups to this URL.
\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":"\nThe Tokens used with record_token_filter_list to decide whether this URL’s webhook fires for a call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nA comma-separated list of HTTP status codes treated as a successful response, for example 200,201.
The path within the response body checked to confirm the request succeeded, for example result.status.
The value the response body’s webhook_body_success_path must match for the request to be treated as successful.
The number of seconds a successful response is cached and reused for a repeat request instead of contacting the remote server again.
\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":"\nWhen true, a caller is added to a suppression list after enough consecutive failures from this URL.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe number of consecutive failures from this URL before the caller is added to the suppression list.
\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":"\nThe suppression list callers are added to once suppression_failure_threshold consecutive failures occur.
When true, a failed request to this URL is retried.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe maximum number of times a failed request to this URL is retried. Must be between 0 and 10.
\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":"\nThe number of seconds to wait before retrying a failed request to this URL. Must be between 30 and 3600.
\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":"\nAssign the record to this Outgoing Webhook.
\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":"\nRemote URL
\n","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":"\nRemote Method
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:get, post, post_body, post_api_v1, put, delete, patch.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"post_body","full_name":"post_body","description":"\nPOST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: {"revenue":10, "caller_id": "1231231234"}
POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: Content-Type: application/json
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nA friendly name for this webhook URL, shown when managing the webhook.
\n","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":"\nThe number of seconds to wait for the remote server’s response before treating the request as failed. Must be between 3 and 29.
\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":"\nWhen true, on save Trackdrive removes query string parameters from the Remote URL and creates a matching Webhook Param for each one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Ping Parsers applied to this URL’s response, used when its webhook fires before dialing a buyer.
\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":"\nMap lead and call data to custom values by assigning these Token Value Map Groups to this URL.
\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":"\nThe Tokens used with record_token_filter_list to decide whether this URL’s webhook fires for a call.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nA comma-separated list of HTTP status codes treated as a successful response, for example 200,201.
The path within the response body checked to confirm the request succeeded, for example result.status.
The value the response body’s webhook_body_success_path must match for the request to be treated as successful.
The number of seconds a successful response is cached and reused for a repeat request instead of contacting the remote server again.
\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":"\nWhen true, a caller is added to a suppression list after enough consecutive failures from this URL.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe number of consecutive failures from this URL before the caller is added to the suppression list.
\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":"\nThe suppression list callers are added to once suppression_failure_threshold consecutive failures occur.
When true, a failed request to this URL is retried.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe maximum number of times a failed request to this URL is retried. Must be between 0 and 10.
\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":"\nThe number of seconds to wait before retrying a failed request to this URL. Must be between 30 and 3600.
\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":"\nFilter for webhooks that are assigned to this Offer.
\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":"\nFilter for webhooks that are assigned to this Buyer.
\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":"\nFilter for webhooks that are assigned to this Schedule Action.
\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":"\nWhen does this trigger fire?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:agent_enter_conference, agent_exit_conference, agent_offline, agent_online, before_answering_call, before_placing_call, before_schedule_action_dial, before_sending_text_message, both_converted, buyer_answered, buyer_answered_with_contact_fields, buyer_before_dial, buyer_converted, buyer_dialled, buyer_did_not_convert, buyer_enter_conference, buyer_exit_conference, call_changed, call_disposition_changed, call_recording_updated, call_recording_updated_call_ended, consumer_enter_conference, consumer_exit_conference, contact_fields_changed, did_not_convert, either_converted, every_call, lead_changed, lead_opted_out, new_call_started, new_lead_created, offer_converted, offer_did_not_convert, only_buyer_converted, only_offer_converted, timer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Assign the webhook to your company to have it fire on all calls.
\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":"\nAssign the record to this Offer.
\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":"\nFilter for webhooks that are assigned to this Buyer.
\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":"\nFilter for webhooks that are assigned to this Buyer Group.
\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":"\nFilter for webhooks that are assigned to this Traffic Source.
\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":"\nFilter for webhooks that are assigned to this Call Flow.
\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":"\nAssign the record to this Schedule Action.
\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":"\nWhen does this trigger fire?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:agent_enter_conference, agent_exit_conference, agent_offline, agent_online, before_answering_call, before_placing_call, before_schedule_action_dial, before_sending_text_message, both_converted, buyer_answered, buyer_answered_with_contact_fields, buyer_before_dial, buyer_converted, buyer_dialled, buyer_did_not_convert, buyer_enter_conference, buyer_exit_conference, call_changed, call_disposition_changed, call_recording_updated, call_recording_updated_call_ended, consumer_enter_conference, consumer_exit_conference, contact_fields_changed, did_not_convert, either_converted, every_call, lead_changed, lead_opted_out, new_call_started, new_lead_created, offer_converted, offer_did_not_convert, only_buyer_converted, only_offer_converted, timer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_duration","full_name":"trigger_duration","description":"\nHow many seconds must pass for the trigger to fire?
\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":"\nRestrict which call statuses fire the webhook. Leave blank to fire regardless of status. live only fires while the call is in progress, ended only fires after the call has completed.
Wait 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.
\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":"\nHow long, in seconds, to cache a successful response from the webhook before checking it again.
\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":"\nThe 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 global_company_id is set.
Fire only after the buyer has answered and all of these Contact Fields have values.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\nMap lead data to custom values by assigning these Token Value Map Groups to the webhook.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nAssign the webhook to your company to have it fire on all calls.
\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":"\nAssign the record to this Offer.
\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":"\nFilter for webhooks that are assigned to this Buyer.
\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":"\nFilter for webhooks that are assigned to this Buyer Group.
\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":"\nFilter for webhooks that are assigned to this Traffic Source.
\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":"\nFilter for webhooks that are assigned to this Call Flow.
\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":"\nAssign the record to this Schedule Action.
\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":"\nWhen does this trigger fire?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:agent_enter_conference, agent_exit_conference, agent_offline, agent_online, before_answering_call, before_placing_call, before_schedule_action_dial, before_sending_text_message, both_converted, buyer_answered, buyer_answered_with_contact_fields, buyer_before_dial, buyer_converted, buyer_dialled, buyer_did_not_convert, buyer_enter_conference, buyer_exit_conference, call_changed, call_disposition_changed, call_recording_updated, call_recording_updated_call_ended, consumer_enter_conference, consumer_exit_conference, contact_fields_changed, did_not_convert, either_converted, every_call, lead_changed, lead_opted_out, new_call_started, new_lead_created, offer_converted, offer_did_not_convert, only_buyer_converted, only_offer_converted, timer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_duration","full_name":"trigger_duration","description":"\nHow many seconds must pass for the trigger to fire?
\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":"\nRestrict which call statuses fire the webhook. Leave blank to fire regardless of status. live only fires while the call is in progress, ended only fires after the call has completed.
Wait 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.
\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":"\nHow long, in seconds, to cache a successful response from the webhook before checking it again.
\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":"\nThe 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 global_company_id is set.
Fire only after the buyer has answered and all of these Contact Fields have values.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\nMap lead data to custom values by assigning these Token Value Map Groups to the webhook.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nThe human friendly name of this webhook.
\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":"\nAssign the webhook to this SMS Flow to have it fire on that flow’s messages.
\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":"\nAssign the webhook to this Call Flow Answer to have it fire when that answer is used.
\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":"\nAssign the webhook to your company to have it fire on all calls.
\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":"\nAssign the record to this Offer.
\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":"\nFilter for webhooks that are assigned to this Buyer.
\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":"\nFilter for webhooks that are assigned to this Buyer Group.
\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":"\nFilter for webhooks that are assigned to this Traffic Source.
\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":"\nFilter for webhooks that are assigned to this Call Flow.
\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":"\nAssign the record to this Schedule Action.
\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":"\nWhen does this trigger fire?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:agent_enter_conference, agent_exit_conference, agent_offline, agent_online, before_answering_call, before_placing_call, before_schedule_action_dial, before_sending_text_message, both_converted, buyer_answered, buyer_answered_with_contact_fields, buyer_before_dial, buyer_converted, buyer_dialled, buyer_did_not_convert, buyer_enter_conference, buyer_exit_conference, call_changed, call_disposition_changed, call_recording_updated, call_recording_updated_call_ended, consumer_enter_conference, consumer_exit_conference, contact_fields_changed, did_not_convert, either_converted, every_call, lead_changed, lead_opted_out, new_call_started, new_lead_created, offer_converted, offer_did_not_convert, only_buyer_converted, only_offer_converted, timer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_duration","full_name":"trigger_duration","description":"\nHow many seconds must pass for the trigger to fire?
\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":"\nRestrict which call statuses fire the webhook. Leave blank to fire regardless of status. live only fires while the call is in progress, ended only fires after the call has completed.
Wait 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.
\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":"\nHow long, in seconds, to cache a successful response from the webhook before checking it again.
\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":"\nThe 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 global_company_id is set.
Fire only after the buyer has answered and all of these Contact Fields have values.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\nMap lead data to custom values by assigning these Token Value Map Groups to the webhook.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sortable_order","full_name":"sortable_order","description":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| number | Default response format. |
| number_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
The phone number.
\n","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":"\nRefer to the offer api for details
\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":"\nRefer to the traffic source api for details
\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":"\nRefer to the provider api for details
\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":"\nRefer to the Number Pool api for details
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Purchase a new phone number using one of your existing provider configurations.
\n","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| number | Default response format. |
| number_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Forward Type - Should the number forward to an Offer or a Buyer
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| offer_id | Forward to Offer |
| buyer_id | Forward to Buyer |
The buyer calls forward to when forward_type is buyer_id. Required with that forward type. If the buyer does not answer, the exception handling of your account’s direct forward offer applies.
Refer to the provider api for details
\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":"\nRefer to the offer api for details
\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":"\nPurchase a toll-free or local number? true for toll-free, false for local number.
\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":"\nThe country where the number will be purchased.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:AU, CA, GB, US.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"requested_number","full_name":"requested_number","description":"\nThe phone number you wish to purchase from /api/v1/phone_numbers/search
\n","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":"\nRefer to the traffic source api for details
\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":"\nRefer to the Number Pool api for details
\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":"\nForce Calls to Credit This Traffic Source and Extra Tokens, even if Lead Traffic Source or Data is Different
\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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| number | Default response format. |
| number_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This can be either the internal trackdrive id or the full phone number beginning with ‘+’
For example:
To find a number using trackdrive’s internal id pass id=185923
To find a number using the phone number pass id=+18005002562"
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| number | Default response format. |
| number_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This can be either the internal trackdrive id or the full phone number beginning with ‘+’
For example:
To find a number using trackdrive’s internal id pass id=185923
To find a number using the phone number pass id=+18005002562"
A note that identifies the number in your account.
\n","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":"\nForward Type - Should the number forward to an Offer or a Buyer
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| offer_id | Forward to Offer |
| buyer_id | Forward to Buyer |
The buyer calls forward to when forward_type is buyer_id. Required with that forward type. If the buyer does not answer, the exception handling of your account’s direct forward offer applies.
Refer to the offer api for details
\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":"\nRefer to the traffic source api for details
\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":"\nRefer to the Number Pool api for details
\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":"\nForce Calls to Credit This Traffic Source and Extra Tokens, even if Lead Traffic Source or Data is Different
\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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\nPause or unpause.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nApply a key press flow group to calls on this number.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe key press flow group applied when use_with_key_press_flows is true.
Which leads to search first when matching an inbound caller to an existing lead.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| schedule_leads_first | [Default] Search for a matching schedule lead before considering offer leads. |
| offer_leads_first | Search for a matching offer lead before considering schedule leads. |
When true, the number cannot be deleted until deletion prevention is turned off.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| number | Default response format. |
| number_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This can be either the internal trackdrive id or the full phone number beginning with ‘+’
For example:
To find a number using trackdrive’s internal id pass id=185923
To find a number using the phone number pass id=+18005002562"
Returns a list of available phone numbers for sale. Can be used with POST /api/v1/phone_numbers?requested_number= to purchase a number.
\n","errors":[],"params":[{"name":"country","full_name":"country","description":"\nTwo-letter country code (default: US)
\n","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":"\nWhether to search toll-free numbers
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prefix","full_name":"prefix","description":"\nRestrict by area code (NPA). Example: 415, 209, 719
\n","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":"\nFull or partial phone number to match
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| provider_configuration | Provider Configuration |
| provider_configuration_grid | Provider Configuration Grid |
Return the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Sort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:id, type, name, created_at, updated_at, deleted_at, max_requests_per_interval, max_requests_per_caller, max_requests_per_number, max_requests_per_provider, requests_interval_for_caller, requests_interval_for_number, requests_interval_for_provider, max_requests_per_second, block_rate_limited_caller, is_default, max_requests_per_npa_nxx, requests_interval_for_npa_nxx, numbers_count, last_call_at, calls_count, recent_calls_count, disconnected_at, connected_status, connected_at.","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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| provider_configuration | Provider Configuration |
| provider_configuration_grid | Provider Configuration Grid |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| provider_configuration | Provider Configuration |
| provider_configuration_grid | Provider Configuration Grid |
Provide a name that will appear throughout Trackdrive.
\n","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":"\nIs this provider the default for new number purchases.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen a caller exceeds its rate limit, permanently block that caller’s number instead of only rejecting the excess calls.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMaximum inbound calls allowed from a single caller within requests_interval_for_caller seconds before it is treated as abusive traffic.
\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":"\nRolling time window, in seconds, used to measure max_requests_per_caller.
\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":"\nMaximum inbound calls allowed to a single tracking number within requests_interval_for_number seconds before it is treated as abusive traffic.
\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":"\nRolling time window, in seconds, used to measure max_requests_per_number.
\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":"\nMaximum inbound calls allowed across this provider account within requests_interval_for_provider seconds before it is treated as abusive traffic.
\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":"\nRolling time window, in seconds, used to measure max_requests_per_provider.
\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":"\nMaximum 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.
\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":"\nRolling time window, in seconds, used to measure max_requests_per_npa_nxx.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Offer
\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":"\nRefer to the provider api for details
\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":"\nTraffic Source
\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":"\nNumbers Count
\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":"\nToll Free
\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":"\nCountry
\n","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":"\nNumber Limit
\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":"\nName
\n","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":"\nA human readable description of this Number Pool.
\n","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":"\nYour own identifier for this Number Pool, used to correlate it with a record in an external system.
\n","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":"\nUse this Number Pool for Dynamic Number Insertion. Only one Number Pool can be active per Offer and Traffic Source.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAssign each website visitor their own number from the pool, so calls can be attributed to that visitor.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow many seconds a number stays assigned to a caller’s token before it can be reassigned.
\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":"\nHow many numbers to keep in reserve, ready and unassigned, within this pool.
\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":"\nAutomatically purchase numbers up to the Number Limit as they are needed.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe preferred area code to purchase numbers from when Auto Rent Numbers is enabled.
\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":"\nPrevent this Number Pool from being used for embedded Dynamic Number Insertion access on more than one Traffic Source per Offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nTrack calls from this Number Pool with Google Analytics.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nYour Google Analytics account id used when Google Analytics is enabled.
\n","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":"\nThe maximum number of seconds a browser will wait for a number to be returned before giving up.
\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":"\nThe number of digits used for extensions when Extensions are enabled on this Number Pool.
\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":"\nThe lowest extension number that can be assigned.
\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":"\nThe highest extension number that can be assigned.
\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":"\nThe Campaign Registry ID applied to every number in this pool for SMS compliance.
\n","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":"\nManually mark every number in this pool as Campaign Registry approved.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nManually mark every number in this pool as Campaign Registry unapproved.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nImmediately purchase numbers until this pool reaches its Number Limit.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nForce calls placed to this Number Pool’s numbers to credit this pool’s Traffic Source, even when the lead’s Traffic Source is different.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen Dial With Area Codes is enabled and no matching area code is available, allow dialing with any area code in the consumer’s state.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe ids of the Token Values whose tokens will be additionally applied to calls handled by this Number Pool.
\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":"\nAssign additional tokens that will be applied to calls handled by this Number Pool by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cid","full_name":"cid","description":"\nAlternative to offer_id. Matches an Offer by your own external Offer identifier instead.
\n","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":"\nAlternative to traffic_source_id. Matches a Traffic Source by your own external Traffic Source identifier instead.
\n","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":"\nThe type of Number Pool, such as RingPool for phone tracking numbers or SmsNumberGroup for SMS sending numbers.
\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":"\nOffer
\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":"\nRefer to the provider api for details
\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":"\nTraffic Source
\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":"\nNumbers Count
\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":"\nToll Free
\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":"\nCountry
\n","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":"\nNumber Limit
\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":"\nName
\n","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":"\nA human readable description of this Number Pool.
\n","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":"\nYour own identifier for this Number Pool, used to correlate it with a record in an external system.
\n","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":"\nUse this Number Pool for Dynamic Number Insertion. Only one Number Pool can be active per Offer and Traffic Source.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAssign each website visitor their own number from the pool, so calls can be attributed to that visitor.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow many seconds a number stays assigned to a caller’s token before it can be reassigned.
\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":"\nHow many numbers to keep in reserve, ready and unassigned, within this pool.
\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":"\nAutomatically purchase numbers up to the Number Limit as they are needed.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe preferred area code to purchase numbers from when Auto Rent Numbers is enabled.
\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":"\nPrevent this Number Pool from being used for embedded Dynamic Number Insertion access on more than one Traffic Source per Offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nTrack calls from this Number Pool with Google Analytics.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nYour Google Analytics account id used when Google Analytics is enabled.
\n","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":"\nThe maximum number of seconds a browser will wait for a number to be returned before giving up.
\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":"\nThe number of digits used for extensions when Extensions are enabled on this Number Pool.
\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":"\nThe lowest extension number that can be assigned.
\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":"\nThe highest extension number that can be assigned.
\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":"\nThe Campaign Registry ID applied to every number in this pool for SMS compliance.
\n","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":"\nManually mark every number in this pool as Campaign Registry approved.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nManually mark every number in this pool as Campaign Registry unapproved.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nImmediately purchase numbers until this pool reaches its Number Limit.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nForce calls placed to this Number Pool’s numbers to credit this pool’s Traffic Source, even when the lead’s Traffic Source is different.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen Dial With Area Codes is enabled and no matching area code is available, allow dialing with any area code in the consumer’s state.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe ids of the Token Values whose tokens will be additionally applied to calls handled by this Number Pool.
\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":"\nAssign additional tokens that will be applied to calls handled by this Number Pool by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cid","full_name":"cid","description":"\nAlternative to offer_id. Matches an Offer by your own external Offer identifier instead.
\n","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":"\nAlternative to traffic_source_id. Matches a Traffic Source by your own external Traffic Source identifier instead.
\n","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":"\nThe type of Number Pool, such as RingPool for phone tracking numbers or SmsNumberGroup for SMS sending numbers.
\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":"\nOffer
\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":"\nRefer to the provider api for details
\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":"\nTraffic Source
\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":"\nNumbers Count
\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":"\nToll Free
\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":"\nCountry
\n","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":"\nNumber Limit
\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":"\nName
\n","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":"\nA human readable description of this Number Pool.
\n","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":"\nYour own identifier for this Number Pool, used to correlate it with a record in an external system.
\n","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":"\nUse this Number Pool for Dynamic Number Insertion. Only one Number Pool can be active per Offer and Traffic Source.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAssign each website visitor their own number from the pool, so calls can be attributed to that visitor.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nHow many seconds a number stays assigned to a caller’s token before it can be reassigned.
\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":"\nHow many numbers to keep in reserve, ready and unassigned, within this pool.
\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":"\nAutomatically purchase numbers up to the Number Limit as they are needed.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe preferred area code to purchase numbers from when Auto Rent Numbers is enabled.
\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":"\nPrevent this Number Pool from being used for embedded Dynamic Number Insertion access on more than one Traffic Source per Offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nTrack calls from this Number Pool with Google Analytics.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nYour Google Analytics account id used when Google Analytics is enabled.
\n","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":"\nThe maximum number of seconds a browser will wait for a number to be returned before giving up.
\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":"\nThe number of digits used for extensions when Extensions are enabled on this Number Pool.
\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":"\nThe lowest extension number that can be assigned.
\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":"\nThe highest extension number that can be assigned.
\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":"\nThe Campaign Registry ID applied to every number in this pool for SMS compliance.
\n","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":"\nManually mark every number in this pool as Campaign Registry approved.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nManually mark every number in this pool as Campaign Registry unapproved.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nImmediately purchase numbers until this pool reaches its Number Limit.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nForce calls placed to this Number Pool’s numbers to credit this pool’s Traffic Source, even when the lead’s Traffic Source is different.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen Dial With Area Codes is enabled and no matching area code is available, allow dialing with any area code in the consumer’s state.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe ids of the Token Values whose tokens will be additionally applied to calls handled by this Number Pool.
\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":"\nAssign additional tokens that will be applied to calls handled by this Number Pool by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cid","full_name":"cid","description":"\nAlternative to offer_id. Matches an Offer by your own external Offer identifier instead.
\n","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":"\nAlternative to traffic_source_id. Matches a Traffic Source by your own external Traffic Source identifier instead.
\n","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":"\nThe type of Number Pool, such as RingPool for phone tracking numbers or SmsNumberGroup for SMS sending numbers.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nThe schedule this action belongs to.
\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":"\nFilter for actions belonging to this action list, such as the schedule’s main actions or its End Of Schedule Actions.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:actions, end_of_schedule_actions, webhook_actions, call_disposition_actions, call_control_actions, key_press_flows, lead_retarget_actions, schedule_actions.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","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":"\nThe schedule this action belongs to.
\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":"\nWhich action list this action belongs to, such as the schedule’s main actions or its End Of Schedule Actions.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:actions, end_of_schedule_actions, webhook_actions, call_disposition_actions, call_control_actions, key_press_flows, lead_retarget_actions, schedule_actions.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_type","full_name":"action_type","description":"\nThe type of action to perform, such as dial, sms, wait, or webhook.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:dial, sms, wait, webhook, add_to_schedule, lead_alteration, zoho_crm, lead_block, lead_opt_out, schedule_callback, choice, restart_schedule, mailchimp, sendgrid, mailgun, infusionsoft, ftp_upload, aws_s3, data_append.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nOnly run this action for leads or calls matching these tokens.
\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":"\nApply these additional tokens to the lead or call when this action runs.
\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":"\nApply these Custom Field Mapping groups to this action.
\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":"\nThe name of this action, shown in the schedule builder.
\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":"\nA human readable description of this action.
\n","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":"\nAssign this action to an Action Group so it can also run from an agent status change or a matched transcription.
\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":"\nThe Lead Wait Rule Group whose rules determine how long to wait, used when action_wait_type is lead_wait_rule_group.
\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":"\nThe provider configuration used to place this action’s calls, SMS, or other outbound communication.
\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":"\nA sub action recognized by the action’s integration, such as send_email or add_to_campaign.
\n","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":"\nWhen enabled, increases the lead’s dial priority each time this action runs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nSwitch how the lead is dialed by an Instant Agent. Accepts dial_with_instant_agent or dial_with_ivr.
\n","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":"\nChange whether an agent’s permission is required before connecting this lead’s caller. Accepts apply_required or remove_required.
\n","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":"\nHow long to wait before continuing. Accepts seconds, minutes, hours, days, time_of_day, or lead_wait_rule_group.
\n","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":"\nThe number of seconds to wait, used when action_wait_type is seconds.
\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":"\nThe number of minutes to wait, used when action_wait_type is minutes.
\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":"\nThe number of hours to wait, used when action_wait_type is hours.
\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":"\nThe number of days to wait, used when action_wait_type is days.
\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":"\nThe 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).
\n","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":"\nThe hour of the day to wait until (0-23), used when action_wait_type is time_of_day.
\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":"\nThe minute of the hour to wait until (0-59), used when action_wait_type is time_of_day.
\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":"\nWhen enabled, this action only proceeds during the schedule’s daylight hours; otherwise it waits until daylight hours resume.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, this action waits until a buyer is available before proceeding.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, this action waits until the lead would convert with an available buyer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhat this action does when it runs. Accepts none or exit_schedule.
\n","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":"\nThe text message to send. Token replacement is supported.
\n","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":"\nSend to this email address instead of the lead’s email. Token replacement is supported.
\n","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":"\nThe from email address.
\n","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":"\nThe from name displayed on the email.
\n","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":"\nThe name displayed for the recipient.
\n","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":"\nThe email subject line. Token replacement is supported.
\n","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":"\nThe email body content. Token replacement is supported.
\n","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":"\nThe sending domain used for this email.
\n","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":"\nThe format of the outgoing email, such as html or text.
\n","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":"\nThe Mailchimp list id leads are added to.
\n","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":"\nThe campaign id in the connected integration that this action applies to.
\n","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":"\nWhen enabled, uses custom_caller_id instead of the lead’s number as the caller id for this action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe caller id to use when use_custom_caller_id is enabled. Token replacement is supported.
\n","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":"\nWhen enabled, uses custom_caller_number_id instead of the schedule’s number to dial the lead.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe number to dial from when use_custom_caller_number is enabled.
\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":"\nWhen enabled, clears the lead’s assigned dial number so a new one is chosen the next time it’s dialed.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, clears the lead’s assigned SMS number so a new one is chosen the next time it sends SMS.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly run this action for calls with this disposition.
\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":"\nThe outgoing webhook this action was generated from, when it fires alongside a webhook.
\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":"\nThe schedule to add or move the lead to.
\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":"\nWhen enabled, moves the lead to the target schedule instead of adding it as a new lead there.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, skips contact field validation when adding the lead to the target schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, unblocks the caller’s number if it was previously blocked.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, only updates a matching existing lead on the target schedule instead of creating a new one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, expires any existing matching leads on the target schedule before adding this one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, deletes any existing matching leads on the target schedule before adding this one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, restarts the schedule for the lead this action adds or updates.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, assigns a dialing number to the lead this action adds or updates.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, assigns an SMS number to the lead this action adds or updates.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applies this lead’s updated data to every other lead with a matching phone number.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe number of hours before a lead added by this action expires.
\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":"\nThe maximum number of contact attempts allowed for a lead added by this action.
\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":"\nWhether 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.
\n","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":"\nThe AWS access key id used to authenticate to the S3 bucket for this upload.
\n","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":"\nThe AWS secret access key used to authenticate to the S3 bucket for this upload.
\n","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":"\nThe AWS region of the S3 bucket, e.g. us-east-1.
\n","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":"\nThe FTP or S3 hostname, or S3 bucket name, to upload to.
\n","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":"\nThe username used to authenticate to the FTP server.
\n","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":"\nThe password used to authenticate to the FTP server.
\n","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":"\nThe directory path the file is uploaded to.
\n","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":"\nThe file name used for the uploaded file.
\n","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":"\nWhen enabled, generates the destination directory if it doesn’t already exist.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, downloads and uploads the file at ftp_remote_file_url instead of ftp_contents_to_upload.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe URL of a file to download and upload, used when ftp_upload_remote_file is enabled. Token replacement is supported.
\n","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":"\nThe text content to upload as a file, used when ftp_upload_remote_file is disabled. Token replacement is supported.
\n","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":"\nWhen enabled, uploads over SFTP instead of FTP.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Data Append Group this action runs.
\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":"\nRun this Call Action when the action fires.
\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":"\nThe Key Press Flow this action uses.
\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":"\nThe Lead Retarget rule this action applies.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nThe schedule this action belongs to.
\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":"\nWhich action list this action belongs to, such as the schedule’s main actions or its End Of Schedule Actions.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:actions, end_of_schedule_actions, webhook_actions, call_disposition_actions, call_control_actions, key_press_flows, lead_retarget_actions, schedule_actions.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_type","full_name":"action_type","description":"\nThe type of action to perform, such as dial, sms, wait, or webhook.
\n","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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nOnly run this action for leads or calls matching these tokens.
\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":"\nApply these additional tokens to the lead or call when this action runs.
\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":"\nApply these Custom Field Mapping groups to this action.
\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":"\nThe name of this action, shown in the schedule builder.
\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":"\nA human readable description of this action.
\n","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":"\nAssign this action to an Action Group so it can also run from an agent status change or a matched transcription.
\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":"\nThe Lead Wait Rule Group whose rules determine how long to wait, used when action_wait_type is lead_wait_rule_group.
\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":"\nThe provider configuration used to place this action’s calls, SMS, or other outbound communication.
\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":"\nA sub action recognized by the action’s integration, such as send_email or add_to_campaign.
\n","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":"\nWhen enabled, increases the lead’s dial priority each time this action runs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nSwitch how the lead is dialed by an Instant Agent. Accepts dial_with_instant_agent or dial_with_ivr.
\n","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":"\nChange whether an agent’s permission is required before connecting this lead’s caller. Accepts apply_required or remove_required.
\n","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":"\nHow long to wait before continuing. Accepts seconds, minutes, hours, days, time_of_day, or lead_wait_rule_group.
\n","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":"\nThe number of seconds to wait, used when action_wait_type is seconds.
\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":"\nThe number of minutes to wait, used when action_wait_type is minutes.
\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":"\nThe number of hours to wait, used when action_wait_type is hours.
\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":"\nThe number of days to wait, used when action_wait_type is days.
\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":"\nThe 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).
\n","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":"\nThe hour of the day to wait until (0-23), used when action_wait_type is time_of_day.
\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":"\nThe minute of the hour to wait until (0-59), used when action_wait_type is time_of_day.
\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":"\nWhen enabled, this action only proceeds during the schedule’s daylight hours; otherwise it waits until daylight hours resume.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, this action waits until a buyer is available before proceeding.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, this action waits until the lead would convert with an available buyer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhat this action does when it runs. Accepts none or exit_schedule.
\n","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":"\nThe text message to send. Token replacement is supported.
\n","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":"\nSend to this email address instead of the lead’s email. Token replacement is supported.
\n","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":"\nThe from email address.
\n","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":"\nThe from name displayed on the email.
\n","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":"\nThe name displayed for the recipient.
\n","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":"\nThe email subject line. Token replacement is supported.
\n","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":"\nThe email body content. Token replacement is supported.
\n","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":"\nThe sending domain used for this email.
\n","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":"\nThe format of the outgoing email, such as html or text.
\n","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":"\nThe Mailchimp list id leads are added to.
\n","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":"\nThe campaign id in the connected integration that this action applies to.
\n","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":"\nWhen enabled, uses custom_caller_id instead of the lead’s number as the caller id for this action.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe caller id to use when use_custom_caller_id is enabled. Token replacement is supported.
\n","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":"\nWhen enabled, uses custom_caller_number_id instead of the schedule’s number to dial the lead.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe number to dial from when use_custom_caller_number is enabled.
\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":"\nWhen enabled, clears the lead’s assigned dial number so a new one is chosen the next time it’s dialed.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, clears the lead’s assigned SMS number so a new one is chosen the next time it sends SMS.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly run this action for calls with this disposition.
\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":"\nThe outgoing webhook this action was generated from, when it fires alongside a webhook.
\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":"\nThe schedule to add or move the lead to.
\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":"\nWhen enabled, moves the lead to the target schedule instead of adding it as a new lead there.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, skips contact field validation when adding the lead to the target schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, unblocks the caller’s number if it was previously blocked.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, only updates a matching existing lead on the target schedule instead of creating a new one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, expires any existing matching leads on the target schedule before adding this one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, deletes any existing matching leads on the target schedule before adding this one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, restarts the schedule for the lead this action adds or updates.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, assigns a dialing number to the lead this action adds or updates.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, assigns an SMS number to the lead this action adds or updates.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, applies this lead’s updated data to every other lead with a matching phone number.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe number of hours before a lead added by this action expires.
\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":"\nThe maximum number of contact attempts allowed for a lead added by this action.
\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":"\nWhether 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.
\n","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":"\nThe AWS access key id used to authenticate to the S3 bucket for this upload.
\n","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":"\nThe AWS secret access key used to authenticate to the S3 bucket for this upload.
\n","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":"\nThe AWS region of the S3 bucket, e.g. us-east-1.
\n","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":"\nThe FTP or S3 hostname, or S3 bucket name, to upload to.
\n","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":"\nThe username used to authenticate to the FTP server.
\n","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":"\nThe password used to authenticate to the FTP server.
\n","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":"\nThe directory path the file is uploaded to.
\n","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":"\nThe file name used for the uploaded file.
\n","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":"\nWhen enabled, generates the destination directory if it doesn’t already exist.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen enabled, downloads and uploads the file at ftp_remote_file_url instead of ftp_contents_to_upload.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe URL of a file to download and upload, used when ftp_upload_remote_file is enabled. Token replacement is supported.
\n","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":"\nThe text content to upload as a file, used when ftp_upload_remote_file is disabled. Token replacement is supported.
\n","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":"\nWhen enabled, uploads over SFTP instead of FTP.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Data Append Group this action runs.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
First Name
\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":"\nInternal 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhat type of Agent is this? Either quality_assurance or buyer
\n","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":"\nUsername
\n","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":"\nLast Name
\n","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":"\nCompany Name
\n","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":"\nPhone Number
\n","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":"\nAddress State
\n","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":"\nAddress City
\n","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":"\nAddress Country
\n","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":"\nAddress Zip
\n","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":"\nAddress Line1
\n","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":"\nAddress Line2
\n","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":"\nDoes this agent belong to a call center?
\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":"\nA photo to display on the agent’s profile, 200px by 200px.
\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":"\nSet to true to remove the agent’s existing profile photo.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe phone number or SIP address calls are forwarded to for this agent.
\n","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":"\nThe phone number shown as the caller ID to consumers when this agent places outbound calls.
\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":"\nFirst Name
\n","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":"\nInternal 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.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhat type of Agent is this? Either quality_assurance or buyer
\n","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":"\nUsername
\n","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":"\nLast Name
\n","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":"\nCompany Name
\n","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":"\nPhone Number
\n","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":"\nAddress State
\n","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":"\nAddress City
\n","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":"\nAddress Country
\n","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":"\nAddress Zip
\n","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":"\nAddress Line1
\n","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":"\nAddress Line2
\n","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":"\nDoes this agent belong to a call center?
\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":"\nA photo to display on the agent’s profile, 200px by 200px.
\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":"\nSet to true to remove the agent’s existing profile photo.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe phone number or SIP address calls are forwarded to for this agent.
\n","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":"\nThe phone number shown as the caller ID to consumers when this agent places outbound calls.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Schedule
\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":"\nTarget Schedule
\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":"\nThe lead will be moved to the target schedule when it matches this Filter Group.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nLeads matching these tokens will be moved to the target schedule.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nSchedule
\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":"\nTarget Schedule
\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":"\nThe lead will be moved to the target schedule when it matches this Filter Group.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nLeads matching these tokens will be moved to the target schedule.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\nAttach an existing Record Token Filter instead of building one from token_value_ids or record_token_filter_list.
\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":"\nSchedule
\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":"\nTarget Schedule
\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":"\nThe lead will be moved to the target schedule when it matches this Filter Group.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nLeads matching these tokens will be moved to the target schedule.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Schedule
\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":"\nNumber Pool
\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":"\nThis Number Pool will be used for outbound calls when the call matches this Filter Group.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nOutbound calls matching these tokens will use this Number Pool.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nSchedule
\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":"\nNumber Pool
\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":"\nThis Number Pool will be used for outbound calls when the call matches this Filter Group.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nOutbound calls matching these tokens will use this Number Pool.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\nAttach an existing Record Token Filter instead of building one from token_value_ids or record_token_filter_list.
\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":"\nSchedule
\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":"\nNumber Pool
\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":"\nThis Number Pool will be used for outbound calls when the call matches this Filter Group.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nOutbound calls matching these tokens will use this Number Pool.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nSchedule internal id
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","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":"\nSchedule internal id
\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":"\nSchedule internal id
\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":"\nThe trigger name
\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":"\nThe schedule ends when the lead has taken this action.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, tokens_match, expired, buyer_connected, buyer_converted, dial.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expire_minutes","full_name":"expire_minutes","description":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nWhich lead timestamp expire_minutes is measured from, such as created_at, first_queued_at, or first_action_at.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:created_at, first_queued_at, first_action_at.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nThe first trigger matching the lead will be used.
\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":"\nThese extra tokens will be applied to leads that exit the schedule through this trigger.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nSchedule internal id
\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":"\nThe trigger name
\n","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":"\nThe schedule ends when the lead has taken this action.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, tokens_match, expired, buyer_connected, buyer_converted, dial.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"expire_minutes","full_name":"expire_minutes","description":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nWhich lead timestamp expire_minutes is measured from, such as created_at, first_queued_at, or first_action_at.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be one of:created_at, first_queued_at, first_action_at.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nThe first trigger matching the lead will be used.
\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":"\nThese extra tokens will be applied to leads that exit the schedule through this trigger.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nThe callback will be made against this call.
\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":"\nThe callback will be made against this lead.
\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":"\nThe telephone number for the consumer who will receive a callback.
\n","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":"\nThe schedule that the callback will be associated with.
\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":"\nThe callback will be made against this call.
\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":"\nThe callback will be made against this lead.
\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":"\nWho Should The Consumer Talk To?
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:me, anyone, connect_with_buyer_id.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_at","full_name":"place_call_at","description":"\nWhen should the callback occur?
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:21 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_time_zone","full_name":"place_call_time_zone","description":"\nThe time zone that will be used when parsing place_call_at
\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":"\nThe callback will be made against this call.
\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":"\nThe callback will be made against this lead.
\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":"\nWho Should The Consumer Talk To?
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:me, anyone, connect_with_buyer_id.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_at","full_name":"place_call_at","description":"\nWhen should the callback occur?
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:21 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"place_call_time_zone","full_name":"place_call_time_zone","description":"\nThe time zone that will be used when parsing place_call_at
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| schedule | Default response format. |
| schedule_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Return the next page of results.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:sortable_order, offer_id, name, paused, offer_id, leads_api_key, time_zone, schedule_type, numbers_count, last_call_at, calls_count, instant_agent_dial_weight, created_at, updated_at, recent_calls_count, use_do_not_call, use_machine_detection, action_dial_skip_mobile, off_hook_enabled, real_time_priority, dial_caller_name, daylight_hours_open, daylight_hours_close, leads_sort_order_type, checked_leads_agent_dial_actions_at, checked_leads_no_match_actions_at.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\nSort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:asc, desc.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\nSearch for any record that matches this text
\n","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\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| schedule | Default response format. |
| schedule_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| schedule | Default response format. |
| schedule_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
The type of schedule to create, eg contact_caller or lead_distribution. Cannot be changed after creation.
Name
\n","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":"\nOffer
\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":"\nA human readable description of the record.
\n","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":"\nPaused
\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":"\nYour own identifier for this schedule, used to correlate it with a record in an external system.
\n","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":"\nTurns on Instant Agent Mode, which sends calls to logged-in agents through dial_agents_number_id instead of a Ring Pool or Number.
The number agents call in to when off_hook_enabled is true.
Whether outbound dialing from this schedule uses a single Number or a Ring Pool.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| number | Dial leads using a single tracking number. |
| ring_pool | Dial leads using a pool of tracking numbers. |
The number used to dial leads when action_dial_with_type is number.
The caller ID name shown to leads when this schedule places a call. Limited to 15 characters.
\n","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":"\nSkip dialing lead phone numbers identified as mobile.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly run TCPA-restricted actions when the current day still allows contacting the lead.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nDelay placing outbound calls until at least this many agents are logged into the offer.
\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":"\nTreat buyers as available for IVR dialing while agents are in QA.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe relative weight given to this schedule when Instant Agent Mode distributes leads across multiple schedules.
\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":"\nAllow Instant Agent Mode to distribute calls for this schedule across other schedules on the same offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe order leads are dialed in during Instant Agent Mode, eg first_in_first_out or last_in_first_out.
The dial priority used when leads_sort_order_type is last_in_first_out.
Allow real-time-priority leads to be dialed outside of business hours.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMix in leads sorted by intersperse_sort_order_type alongside the normal dial order.
The sort order used for the interspersed leads when intersperse_leads is true.
The percentage of dialed leads, between 5 and 95, drawn from the interspersed sort order.
\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":"\nThe percentage of the offer’s concurrency cap this schedule may use for outbound calls. Leave blank for unlimited.
\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":"\nThe maximum number of calls this schedule will hold at once.
\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":"\nHow long, in seconds, a scheduled callback remains valid before it expires.
\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":"\nHow long, in seconds, to wait before moving a lead to the next dial action.
\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":"\nAllow leads on this schedule to be placed into scheduled callbacks.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAutomatically place scheduled callbacks instead of requiring an agent to dial them manually.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nUse answering machine detection on outbound calls from this schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nSend SMS actions from a Ring Pool instead of a single number.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Ring Pool used to send SMS actions when action_sms_use_ring_pool is true.
The number used to send SMS actions when action_sms_use_ring_pool is false.
Require the lead’s permission before running certain schedule actions.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe action types that require contact caller permission when contact_caller_permission_required is true.
[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\nReject leads submitted to this schedule without a traffic_source_id.
Reject a lead when another lead with the same traffic source already exists on this schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nValidate submitted leads against this schedule’s contact field configuration.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nReject leads whose phone number has fewer digits than this.
\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":"\nReject leads whose phone number has more digits than this.
\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":"\nWhether lead_duplicate_timeframe checks for duplicates within this schedule or across the whole company.
| Acceptable Value | Description |
|---|---|
| schedule_id | Dedupe against leads on this schedule only. |
| company_id | Dedupe against all leads in your account. |
The maximum number of leads accepted from the same remote IP within max_leads_per_remote_ip_interval.
The interval, in seconds, over which max_leads_per_remote_ip is enforced.
Reject leads whose number is on the Do Not Call list.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nReject leads whose number belongs to a known DNC litigator.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nReject leads whose number is not in service.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Buyer Suppression list used to suppress leads and callers on this schedule.
\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":"\nCheck leads against TCPA Shield before dialing them.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe TCPA Shield integration used when tcpa_shield_enabled is true.
Check leads against Blacklist Alliance before dialing them.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Blacklist Alliance integration used when blacklist_alliance_enabled is true.
The time of day, in HHMM format using the lead’s local time zone, that daylight hours dialing opens.
The time of day, in HHMM format using the lead’s local time zone, that daylight hours dialing closes.
The time of day, in HHMM format using the schedule’s time zone, that scheduled callbacks may start being placed.
The time of day, in HHMM format using the schedule’s time zone, that scheduled callbacks stop being placed.
Publish this schedule’s posting instructions page. Turning this on requires the company to have completed identity verification.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nList this schedule’s posting instructions page on the company’s public index.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe title shown on this schedule’s public posting instructions page.
\n","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":"\nThe rich-text description shown on this schedule’s public posting instructions page.
\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":"\nPlaces an outbound call immediately. This is the endpoint to use for a “promote” / “call now” action.
Identifying who to call (choose one):
• lead_id — dials that exact existing Lead. Its number is used as to and its schedule is used to dial. Nothing new is created, so a promote never produces a duplicate lead. This is the recommended option.
• lead_token (a Schedule’s “Leads API Key”) or schedule_id — identifies the Schedule to dial from. You must also pass to (the number to dial).
Schedule / lead distribution routing:
The resolved schedule takes the same code path as POST /api/v1/leads. If it is a lead-distribution (“router”) schedule, the matching distribution is resolved from the submitted data (eg traffic_source_id) and the call is routed to that distribution’s downstream target schedule. If no distribution matches, the request is rejected.
Which lead gets dialed (when using lead_token/schedule_id + to):
• 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).
• 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.
Guards enforced before dialing:
• The schedule must be active.
• Account CPS (calls per second) limit.
• DNC / contact suppression rules.
• The same number cannot be dialed more than once every 30 seconds.
• The destination number must be valid.
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.
The 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 to, lead_token and schedule_id are not required and are ignored. This is the preferred way to promote a lead you already created, because it never creates a duplicate.
The ID of the Schedule to dial from. Must belong to the current company and be active. Use this (or lead_token) together with to when you are not passing a lead_id.
The token for the Schedule where you want lead to originate. Get it from: trackdrive.com/schedules
\n","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":"\nDestination phone number to dial. Must be a valid number and not suppressed. Required unless a lead_id is provided (in which case the lead’s number is used).
Optional hash of additional lead attributes (eg traffic_source_id). Used to route the lead through a lead-distribution schedule and stored on any lead that is created.
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| schedule | Default response format. |
| schedule_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| schedule | Default response format. |
| schedule_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Name
\n","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":"\nOffer
\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":"\nA human readable description of the record.
\n","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":"\nPaused
\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":"\nYour own identifier for this schedule, used to correlate it with a record in an external system.
\n","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":"\nTurns on Instant Agent Mode, which sends calls to logged-in agents through dial_agents_number_id instead of a Ring Pool or Number.
The number agents call in to when off_hook_enabled is true.
Whether outbound dialing from this schedule uses a single Number or a Ring Pool.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:| Acceptable Value | Description |
|---|---|
| number | Dial leads using a single tracking number. |
| ring_pool | Dial leads using a pool of tracking numbers. |
The number used to dial leads when action_dial_with_type is number.
The caller ID name shown to leads when this schedule places a call. Limited to 15 characters.
\n","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":"\nSkip dialing lead phone numbers identified as mobile.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nOnly run TCPA-restricted actions when the current day still allows contacting the lead.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nDelay placing outbound calls until at least this many agents are logged into the offer.
\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":"\nTreat buyers as available for IVR dialing while agents are in QA.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe relative weight given to this schedule when Instant Agent Mode distributes leads across multiple schedules.
\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":"\nAllow Instant Agent Mode to distribute calls for this schedule across other schedules on the same offer.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe order leads are dialed in during Instant Agent Mode, eg first_in_first_out or last_in_first_out.
The dial priority used when leads_sort_order_type is last_in_first_out.
Allow real-time-priority leads to be dialed outside of business hours.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nMix in leads sorted by intersperse_sort_order_type alongside the normal dial order.
The sort order used for the interspersed leads when intersperse_leads is true.
The percentage of dialed leads, between 5 and 95, drawn from the interspersed sort order.
\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":"\nThe percentage of the offer’s concurrency cap this schedule may use for outbound calls. Leave blank for unlimited.
\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":"\nThe maximum number of calls this schedule will hold at once.
\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":"\nHow long, in seconds, a scheduled callback remains valid before it expires.
\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":"\nHow long, in seconds, to wait before moving a lead to the next dial action.
\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":"\nAllow leads on this schedule to be placed into scheduled callbacks.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nAutomatically place scheduled callbacks instead of requiring an agent to dial them manually.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nUse answering machine detection on outbound calls from this schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nSend SMS actions from a Ring Pool instead of a single number.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Ring Pool used to send SMS actions when action_sms_use_ring_pool is true.
The number used to send SMS actions when action_sms_use_ring_pool is false.
Require the lead’s permission before running certain schedule actions.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe action types that require contact caller permission when contact_caller_permission_required is true.
[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\nReject leads submitted to this schedule without a traffic_source_id.
Reject a lead when another lead with the same traffic source already exists on this schedule.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nValidate submitted leads against this schedule’s contact field configuration.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nReject leads whose phone number has fewer digits than this.
\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":"\nReject leads whose phone number has more digits than this.
\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":"\nWhether lead_duplicate_timeframe checks for duplicates within this schedule or across the whole company.
| Acceptable Value | Description |
|---|---|
| schedule_id | Dedupe against leads on this schedule only. |
| company_id | Dedupe against all leads in your account. |
The maximum number of leads accepted from the same remote IP within max_leads_per_remote_ip_interval.
The interval, in seconds, over which max_leads_per_remote_ip is enforced.
Reject leads whose number is on the Do Not Call list.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nReject leads whose number belongs to a known DNC litigator.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nReject leads whose number is not in service.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Buyer Suppression list used to suppress leads and callers on this schedule.
\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":"\nCheck leads against TCPA Shield before dialing them.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe TCPA Shield integration used when tcpa_shield_enabled is true.
Check leads against Blacklist Alliance before dialing them.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe Blacklist Alliance integration used when blacklist_alliance_enabled is true.
The time of day, in HHMM format using the lead’s local time zone, that daylight hours dialing opens.
The time of day, in HHMM format using the lead’s local time zone, that daylight hours dialing closes.
The time of day, in HHMM format using the schedule’s time zone, that scheduled callbacks may start being placed.
The time of day, in HHMM format using the schedule’s time zone, that scheduled callbacks stop being placed.
Publish this schedule’s posting instructions page. Turning this on requires the company to have completed identity verification.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nList this schedule’s posting instructions page on the company’s public index.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe title shown on this schedule’s public posting instructions page.
\n","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":"\nThe rich-text description shown on this schedule’s public posting instructions page.
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nThe period of time, in seconds, that must elapse before the same caller can create another lead on this schedule.
\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":"\nThis endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.
| Acceptable Value | Description |
|---|---|
| schedule | Default response format. |
| schedule_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Key
\n","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":"\nThe secret’s value, such as an API key or credential, stored encrypted so it can be referenced elsewhere without exposing it directly.
\n","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":"\nDescription
\n","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":"\nSet to true to replace the stored value with the value given in this request; otherwise the existing value is kept.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nKey
\n","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":"\nThe secret’s value, such as an API key or credential, stored encrypted so it can be referenced elsewhere without exposing it directly.
\n","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":"\nDescription
\n","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":"\nSet to true to replace the stored value with the value given in this request; otherwise the existing value is kept.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nKey
\n","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":"\nThe secret’s value, such as an API key or credential, stored encrypted so it can be referenced elsewhere without exposing it directly.
\n","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":"\nDescription
\n","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":"\nSet to true to replace the stored value with the value given in this request; otherwise the existing value is kept.
\n","required":false,"allow_nil":true,"allow_blank":true,"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 usingtd_secure_token and td_uuid passed in a call's SIP headers. These endpoints do not require authentication with a auth_token","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":"\nUpdate a call with td_secure_token and td_uuid passed in a call’s SIP headers.
The secure token used to authorize access to an individual object. Must be 40 characters.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression/.{40}/.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\nA unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1
\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":"\nThe revenue paid out for the call.
\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":"\nDid the buyer convert?
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nDTMF digit
\n","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":"\nUpdate the call with this data. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'}
Hang up an ongoing call using a td_secure_token and td_uuid passed in a call’s SIP headers.
The secure token used to authorize access to an individual object. Must be 40 characters.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression/.{40}/.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\nA unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1
\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":"\nThe secure token used to authorize access to an individual object. Must be 40 characters.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression/.{40}/.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uuid","full_name":"uuid","description":"\nA unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Sip Header Parser Group
\n","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":"\nSip Header Key
\n","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":"\nContact Field Key
\n","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":"\nDescription
\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":"\nSip Header Parser Group
\n","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":"\nSip Header Key
\n","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":"\nContact Field Key
\n","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":"\nDescription
\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":"\nSip Header Parser Group
\n","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":"\nSip Header Key
\n","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":"\nContact Field Key
\n","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":"\nDescription
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Id
\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":"\nBuyer
\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":"\nKey
\n","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":"\nValue
\n","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":"\nAssign the internal ids for filtering.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nId
\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":"\nBuyer
\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":"\nKey
\n","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":"\nValue
\n","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":"\nAssign the internal ids for filtering.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nId
\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":"\nBuyer
\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":"\nKey
\n","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":"\nValue
\n","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":"\nAssign the internal ids for filtering.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\n","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":"\nAudio File
\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":"\nThe Playlists this sound file belongs to.
\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":"\nPlay this sound file only when the call matches these Tokens.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nName
\n","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":"\nDescription
\n","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":"\nAudio File
\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":"\nThe Playlists this sound file belongs to.
\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":"\nPlay this sound file only when the call matches these Tokens.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nName
\n","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":"\nDescription
\n","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":"\nAudio File
\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":"\nThe Playlists this sound file belongs to.
\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":"\nPlay this sound file only when the call matches these Tokens.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\n","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":"\nHow sound files in this playlist are picked for playback. One of sortable_order, random, or round_robin.
sortable_order, random, round_robin.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_predefined_playlist","full_name":"use_predefined_playlist","description":"\nWhen true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe built-in Trackdrive playlist played when use_predefined_playlist is true.
The Sound Files in this playlist, in playback order.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nHow sound files in this playlist are picked for playback. One of sortable_order, random, or round_robin.
sortable_order, random, round_robin.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_predefined_playlist","full_name":"use_predefined_playlist","description":"\nWhen true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe built-in Trackdrive playlist played when use_predefined_playlist is true.
The Sound Files in this playlist, in playback order.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nHow sound files in this playlist are picked for playback. One of sortable_order, random, or round_robin.
sortable_order, random, round_robin.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_predefined_playlist","full_name":"use_predefined_playlist","description":"\nWhen true, this playlist plays a built-in Trackdrive playlist instead of its own uploaded sound files.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nThe built-in Trackdrive playlist played when use_predefined_playlist is true.
The Sound Files in this playlist, in playback order.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Audio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.
\n","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":"\nPostback URL that we will send the following JSON payload to when the transcription is complete: id, highlighted_utterances, keywords, data, body, utterances, file_url
\n","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":"\nCaller ID associated with the audio file, which may be used for addition triggers and actions.
\n","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":"\nIs the audio file dual channel?
\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":"\nNumber of people (speakers) in the audio file.
\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":"\nWhen keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”
\n","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":"\nWhen keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”
\n","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":"\nTranscription 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.
\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":"\nOffer 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.
\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":"\nA 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 > Action settings).
\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":"\nAudio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.
\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":"\nPostback URL that we will send the following JSON payload to when the transcription is complete: id, highlighted_utterances, keywords, data, body, utterances, file_url
\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":"\nCaller ID associated with the audio file, which may be used for addition triggers and actions.
\n","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":"\nIs the audio file dual channel?
\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":"\nNumber of people (speakers) in the audio file.
\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":"\nWhen keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”
\n","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":"\nWhen keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”
\n","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":"\nTranscription 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.
\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":"\nOffer 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.
\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":"\nA 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 > Action settings).
\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":"\nCaller ID associated with the audio file, which may be used for addition triggers and actions.
\n","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":"\nIs the audio file dual channel?
\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":"\nNumber of people (speakers) in the audio file.
\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":"\nWhen keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”
\n","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":"\nWhen keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”
\n","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":"\nTranscription 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.
\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":"\nOffer 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.
\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":"\nA 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 > Action settings).
\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":"\nThe original data that was provided when the transcription record was created.
\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":"\nKeywords that were found in the audio file.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nUtterances are the spoken words in the audio file, broken down by speaker.
\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":"\nHighlighted Utterances are the spoken words in the audio file, broken down by speaker, with keywords highlighted.
\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":"\nReturns true if the audio file has been transcribed and keywords have been highlighted.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe detected duration of the audio file in seconds.
\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":"\nThe raw transcription text of the audio file.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
States
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nMonday Open At
\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":"\nMonday Close At
\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":"\nTuesday Open At
\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":"\nTuesday Close At
\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":"\nWednesday Open At
\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":"\nWednesday Close At
\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":"\nThursday Open At
\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":"\nThursday Close At
\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":"\nFriday Open At
\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":"\nFriday Close At
\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":"\nSaturday Open At
\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":"\nSaturday Close At
\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":"\nSunday Open At
\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":"\nSunday Close At
\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":"\nWhen true, outbound calls to this state are blocked all day Monday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Tuesday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Wednesday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Thursday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Friday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Saturday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Sunday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nStates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nMonday Open At
\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":"\nMonday Close At
\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":"\nTuesday Open At
\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":"\nTuesday Close At
\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":"\nWednesday Open At
\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":"\nWednesday Close At
\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":"\nThursday Open At
\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":"\nThursday Close At
\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":"\nFriday Open At
\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":"\nFriday Close At
\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":"\nSaturday Open At
\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":"\nSaturday Close At
\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":"\nSunday Open At
\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":"\nSunday Close At
\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":"\nWhen true, outbound calls to this state are blocked all day Monday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Tuesday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Wednesday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Thursday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Friday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Saturday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Sunday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nStates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nMonday Open At
\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":"\nMonday Close At
\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":"\nTuesday Open At
\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":"\nTuesday Close At
\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":"\nWednesday Open At
\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":"\nWednesday Close At
\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":"\nThursday Open At
\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":"\nThursday Close At
\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":"\nFriday Open At
\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":"\nFriday Close At
\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":"\nSaturday Open At
\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":"\nSaturday Close At
\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":"\nSunday Open At
\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":"\nSunday Close At
\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":"\nWhen true, outbound calls to this state are blocked all day Monday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Tuesday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Wednesday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Thursday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Friday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Saturday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nWhen true, outbound calls to this state are blocked all day Sunday, regardless of the open/close times.
\n","required":false,"allow_nil":true,"allow_blank":true,"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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
States
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nCall Limit Interval
\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":"\nCall Limit Limit
\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":"\nStates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nCall Limit Interval
\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":"\nCall Limit Limit
\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":"\nStates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nCall Limit Interval
\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":"\nCall Limit Limit
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
States
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"holiday_dates","full_name":"holiday_dates","description":"\nHoliday Dates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\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":"\nStates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"holiday_dates","full_name":"holiday_dates","description":"\nHoliday Dates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\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":"\nStates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"holiday_dates","full_name":"holiday_dates","description":"\nHoliday Dates
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Rule Scope
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:company, offer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_ids","full_name":"offer_ids","description":"\nOffer Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nDescription
\n","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":"\nState Business Hour Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\nState Call Limit Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\nState Holidays Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","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":"\nRule Scope
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:company, offer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_ids","full_name":"offer_ids","description":"\nOffer Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nDescription
\n","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":"\nState Business Hour Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\nState Call Limit Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\nState Holidays Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","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":"\nRule Scope
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:company, offer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_ids","full_name":"offer_ids","description":"\nOffer Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\nName
\n","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":"\nDescription
\n","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":"\nState Business Hour Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_call_limit_ids","full_name":"state_call_limit_ids","description":"\nState Call Limit Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"state_holiday_ids","full_name":"state_holiday_ids","description":"\nState Holidays Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","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":"\nReturn the next page of results.
\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":"\nThe unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.
\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":"\nThe event that will be triggered. EG: When a new call comes in.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:new_call, call_ringing, call_forwarded, call_ended, call_changed, new_lead, lead_ended, lead_converted, lead_opted_out, lead_changed, incoming_text_message.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"trigger_fields","full_name":"trigger_fields","description":"\nFilter the data returned by the subscription. Only trigger if the object matches the given trigger fields. For example:
{buyer_converted: true, offer_id: 1} would only fire the trigger if the call converted and came from offer 1. Acceptable triggers: schedule_id traffic_source_id offer_id buyer_converted has_recording either_converted buyer_id offer_converted number_id
The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.
\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":"\nThe event that will be triggered. EG: When a new call comes in.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:new_call, call_ringing, call_forwarded, call_ended, call_changed, new_lead, lead_ended, lead_converted, lead_opted_out, lead_changed, incoming_text_message.","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":"\nThe unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Description
\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":"\nOffer
\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":"\nParse Value With Expression
\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":"\nValue Formatter
\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":"\nValue Expression
\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":"\nUse Flow When Pattern Matches
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRequest A Response
\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":"\nThe outgoing SMS message sent back to the consumer when this flow matches the incoming message.
\n","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":"\nAssert Acceptable With Contact Field
\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":"\nResponse Message When Unacceptable
\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":"\nAttribution Token Value Ids
\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":"\nThe Contact Field the consumer’s reply is saved to on the lead.
\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":"\nThe Contact Field checked against the accepted responses when assert_acceptable_with_contact_field is true.
How the consumer’s reply is passed on for further processing after this flow matches. One of nested_text_message_flows (try the nested SMS Flows below this one) or parent_text_message_flows (pass it to this flow’s parent Offer or SMS Flow).
A comma-separated list of the responses accepted as valid when assert_acceptable_with_contact_field is true.
How many seconds Trackdrive waits for the consumer’s reply before giving up on this flow.
\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":"\nThe parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nDescription
\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":"\nOffer
\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":"\nParse Value With Expression
\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":"\nValue Formatter
\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":"\nValue Expression
\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":"\nUse Flow When Pattern Matches
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRequest A Response
\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":"\nThe outgoing SMS message sent back to the consumer when this flow matches the incoming message.
\n","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":"\nAssert Acceptable With Contact Field
\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":"\nResponse Message When Unacceptable
\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":"\nAttribution Token Value Ids
\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":"\nThe Contact Field the consumer’s reply is saved to on the lead.
\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":"\nThe Contact Field checked against the accepted responses when assert_acceptable_with_contact_field is true.
How the consumer’s reply is passed on for further processing after this flow matches. One of nested_text_message_flows (try the nested SMS Flows below this one) or parent_text_message_flows (pass it to this flow’s parent Offer or SMS Flow).
A comma-separated list of the responses accepted as valid when assert_acceptable_with_contact_field is true.
How many seconds Trackdrive waits for the consumer’s reply before giving up on this flow.
\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":"\nThe parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nDescription
\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":"\nOffer
\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":"\nParse Value With Expression
\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":"\nValue Formatter
\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":"\nValue Expression
\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":"\nUse Flow When Pattern Matches
\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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nRequest A Response
\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":"\nThe outgoing SMS message sent back to the consumer when this flow matches the incoming message.
\n","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":"\nAssert Acceptable With Contact Field
\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":"\nResponse Message When Unacceptable
\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":"\nAttribution Token Value Ids
\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":"\nThe Contact Field the consumer’s reply is saved to on the lead.
\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":"\nThe Contact Field checked against the accepted responses when assert_acceptable_with_contact_field is true.
How the consumer’s reply is passed on for further processing after this flow matches. One of nested_text_message_flows (try the nested SMS Flows below this one) or parent_text_message_flows (pass it to this flow’s parent Offer or SMS Flow).
A comma-separated list of the responses accepted as valid when assert_acceptable_with_contact_field is true.
How many seconds Trackdrive waits for the consumer’s reply before giving up on this flow.
\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":"\nThe parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nSending address (+E.164 formatted phone number.) Example: +18665550001
\n","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":"\nReceiving address (+E.164 formatted phone number.) Example: +18665550001
\n","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":"\nOptional. Associate this text message with this lead. The lead’s telephone number will be used as the Receiving address if “to” is not provided.
\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":"\nMessage body (i.e., content) as non-empty string. Example: Hello!
\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":"\nWebhook to call when the message’s status changes.
\n","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":"\nPass 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.
\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":"\nProvide the sending address as an internal Trackdrive telephone number ID.
\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":"\nOptional. 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.
\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":"\nOptional. Associate this text message with a matching lead on this offer. If no lead currently exists, one will be created on this offer.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Filter for records that belong to this Offer.
\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":"\nThe ID for the record that owns this record.
\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":"\nThe type of record that owns this record.
\n","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Assign the record to this Offer.
\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":"\nThe ID for the record that owns this record.
\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":"\nThe type of record that owns this record.
\n","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":"\nThe internal token name where values are stored.
\n","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":"\nThis URL key will be assigned to a Trackdrive Token.
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nLink directly to an existing Token by its id instead of matching by token name.
\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":"\nAssign the record to this Offer.
\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":"\nThe ID for the record that owns this record.
\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":"\nThe type of record that owns this record.
\n","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":"\nThe internal token name where values are stored.
\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":"\nThis URL key will be assigned to a Trackdrive Token.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nLink directly to an existing Token by its id instead of matching by token name.
\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":"\nAssign the record to this Offer.
\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":"\nThe ID for the record that owns this record.
\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":"\nThe type of record that owns this record.
\n","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":"\nThe internal token name where values are stored.
\n","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":"\nThis URL key will be assigned to a Trackdrive Token.
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nLink directly to an existing Token by its id instead of matching by token name.
\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":"\nFilter by this key.
\n","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":"\nFilter by this value.
\n","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":"\nFilter by this token.
\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":"\nFilter by this operator.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:==, !=, =~, !~, <, <=, >, >=.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return the next page of results.
\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":"\nBackground Color
\n","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":"\nBackground Color
\n","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":"\nThe order in which this token appears in lists and reports. Lower values are shown first.
\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":"\nKey
\n","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":"\nAn alias for key.
\n","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":"\nA human readable description of what this token stores.
\n","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":"\nWhen true, this token only accepts numeric values.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nCarry this token’s value forward from the caller’s previous call when the current call does not supply one.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nPlay an IVR message asking the caller to press a key, and store their key press as this token’s value.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nA fixed value to always use for this token, ignoring any value supplied on the call or lead.
\n","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":"\nWhen true, always use static_value for this token instead of the value supplied on the call or lead.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nRestrict this token to a defined list of acceptable values instead of accepting any properly formatted value.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"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":"\nComma separated list of the values this token will accept when acceptable_tokens_enabled is true.
\n","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":"\nThe ids of the existing Token Values this token will accept when acceptable_tokens_enabled is true.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","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":"\nThe token that determines where submitted data is routed. Get it from the Offer or Schedule.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\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":"\nName
\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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
The parent rate limiter group ID.
\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":"\nThe traffic source ID.
\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":"\nThe parent rate limiter group ID.
\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":"\nThe traffic source ID.
\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":"\nMaximum pings per minute for this traffic source.
\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":"\nMaximum pings per hour for this traffic source.
\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":"\nMaximum pings per day for this traffic source.
\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":"\nThe parent rate limiter group ID.
\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":"\nThe traffic source ID.
\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":"\nMaximum pings per minute for this traffic source.
\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":"\nMaximum pings per hour for this traffic source.
\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":"\nMaximum pings per day for this traffic source.
\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":"\nReturn the next page of results.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSort results by this field.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:created_at, updated_at, first_name, last_name, company_name, numbers_count, recent_calls_count, last_call_at, calls_count, user_traffic_source_id, number_limit.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\nSort results in ascending or descending order.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:asc, desc.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\nSearch for any record that matches this text
\n","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\nYour own unique identifier for the Traffic Source, also known as an AFID.
\n","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":"\nThe first name for the Traffic Source’s contact.
\n","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":"\nThe last name for the Traffic Source’s contact.
\n","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":"\nThe company name for the Traffic Source’s contact.
\n","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":"\nA free-text note about this Traffic Source, stored alongside it and returned in the API response.
\n","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":"\nHow many numbers can team members purchase for this Traffic Source?
\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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\nGive this Traffic Source access to this Offer.
\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":"\nRemove access to this Offer for this Traffic Source.
\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":"\nGrant access to this Traffic Source, and calls that it publishes.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe selected users will receive an email invitation to collaborate on your company.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG:[\"john-smith@gmail.com\", \"example@domain.com\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\nTeam members will be able to buy numbers for these offers, and view calls published to them by their Traffic Source.
\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":"\nYour own unique identifier for the Traffic Source, also known as an AFID.
\n","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":"\nThe first name for the Traffic Source’s contact.
\n","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":"\nThe last name for the Traffic Source’s contact.
\n","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":"\nThe company name for the Traffic Source’s contact.
\n","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":"\nA free-text note about this Traffic Source, stored alongside it and returned in the API response.
\n","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":"\nHow many numbers can team members purchase for this Traffic Source?
\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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"grant_team_offer_id","full_name":"grant_team_offer_id","description":"\nGive this Traffic Source access to this Offer.
\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":"\nRemove access to this Offer for this Traffic Source.
\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":"\nGrant access to this Traffic Source, and calls that it publishes.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"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":"\nThe selected users will receive an email invitation to collaborate on your company.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of emails. EG:[\"john-smith@gmail.com\", \"example@domain.com\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"team_offer_ids","full_name":"team_offer_ids","description":"\nTeam members will be able to buy numbers for these offers, and view calls published to them by their Traffic Source.
\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":"\nPause or unpause.
\n","required":false,"allow_nil":false,"allow_blank":false,"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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Transcription Flow Group
\n","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":"\nName
\n","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":"\nRecording Types
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nDescription
\n","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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nThe Transcription Keyword Group scanned for in this flow’s transcripts, if any.
\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":"\nRun this Schedule Action Group against the call after its transcript is ready.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nTranscription Flow Group
\n","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":"\nName
\n","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":"\nRecording Types
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nDescription
\n","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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nThe Transcription Keyword Group scanned for in this flow’s transcripts, if any.
\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":"\nRun this Schedule Action Group against the call after its transcript is ready.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nTranscription Flow Group
\n","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":"\nName
\n","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":"\nRecording Types
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nDescription
\n","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":"\nRecord Token Filter
\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":"\nToken Value Ids
\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":"\nThe Transcription Keyword Group scanned for in this flow’s transcripts, if any.
\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":"\nRun this Schedule Action Group against the call after its transcript is ready.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nName
\n","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":"\nDescription
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Transcription Keyword Group
\n","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":"\nDetection Channel
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:caller, others, all.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\nKey
\n","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":"\nValues
\n","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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nKeywords
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nA note describing what this Transcription Keyword detects, shown when managing your keywords.
\n","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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nTranscription Keyword Group
\n","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":"\nDetection Channel
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:caller, others, all.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\nKey
\n","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":"\nValues
\n","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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nKeywords
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nA note describing what this Transcription Keyword detects, shown when managing your keywords.
\n","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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nTranscription Keyword Group
\n","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":"\nDetection Channel
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of:caller, others, all.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\nKey
\n","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":"\nValues
\n","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":"\nRecord Token Additional
\n","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":"\nAttribution Token Value Ids
\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":"\nKeywords
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of strings. EG:[\"abc123\", \"xzy023\"]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\nA note describing what this Transcription Keyword detects, shown when managing your keywords.
\n","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":"\nAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of tokens. Example tokens:buyer_interest:loan,another_token:value","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_id","full_name":"call_id","description":"\nThe internal id for a call on Trackdrive.
\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":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Description
\n","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":"\nBlocked At From
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:21 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked_at_to","full_name":"blocked_at_to","description":"\nBlocked At To
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:21 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_ip","full_name":"request_ip","description":"\nRequest Ip
\n","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":"\nLast Contact
\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":"\nDescription
\n","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":"\nBlocked At From
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:21 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"blocked_at_to","full_name":"blocked_at_to","description":"\nBlocked At To
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2026-09-28 02:00:21 +0000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_ip","full_name":"request_ip","description":"\nRequest Ip
\n","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":"\nLast Contact
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Number
\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":"\nNumber
\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":"\nRefer to the offer api for details
\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":"\nRefer to the Number Pool api for details
\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":"\nRefer to the traffic source api for details
\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":"\nTranslation missing: en.api.description
\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":"\nFilter for records that belong to this Offer.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Assign the record to this Offer.
\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":"\nThe internal token name where values are stored.
\n","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":"\nThis URL key will be assigned to a Trackdrive Token.
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nAssign the record to this Offer.
\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":"\nThe internal token name where values are stored.
\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":"\nThis URL key will be assigned to a Trackdrive Token.
\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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nAssign the record to this Offer.
\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":"\nThe internal token name where values are stored.
\n","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":"\nThis URL key will be assigned to a Trackdrive Token.
\n","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":"\nThe order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results. A per_page request parameter > 10 is not allowed, cursor must be used instead.
\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":"\nThe 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 metadata.next_cursor. 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.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Return records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Outgoing Webhook Url
\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":"\nKey
\n","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":"\nValue
\n","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":"\nThe Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nOutgoing Webhook Url
\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":"\nKey
\n","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":"\nValue
\n","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":"\nThe Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nOutgoing Webhook Url
\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":"\nKey
\n","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":"\nValue
\n","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":"\nThe Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL.
\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":"\nThe Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires.
\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":"\nAssign filters to the object by passing an array of key:value pairs
\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\"interest:auto\", \"loan_amount:>=10000\", \"loan_amount:<=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"","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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Zip Code List
\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":"\nName
\n","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":"\nDescription
\n","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":"\nImport File
\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":"\nZip Code List
\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":"\nName
\n","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":"\nDescription
\n","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":"\nImport File
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Name
\n","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":"\nDescription
\n","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":"\nA 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.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nA 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.
\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":"\nName
\n","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":"\nDescription
\n","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":"\nA 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.
\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":"\nReturn records matching these ids.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG:[0, 1, 2, 3]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\nReturn the next page of results.
\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":"\nHow many results to return per page. The default is 25.
\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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nDate formatted like 2016-01-01 12:25:15 -0500
\n","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":"\nSearch for any record that matches this text
\n","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":"\nDate ranges will be parsed using this time zone.
\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\nPass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}
Schedule Action
\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":"\nAction Type
\n","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":"\nModule Type
\n","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":"\nModule Primary Key
\n","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":"\nThe Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.
\n","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":"\nMap lead and call data to custom values by assigning these Token Value Map Groups to this action.
\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":"\nSchedule Action
\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":"\nAction Type
\n","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":"\nModule Type
\n","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":"\nModule Primary Key
\n","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":"\nThe Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.
\n","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":"\nMap lead and call data to custom values by assigning these Token Value Map Groups to this action.
\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":"\nSchedule Action
\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":"\nAction Type
\n","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":"\nModule Type
\n","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":"\nModule Primary Key
\n","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":"\nThe Zoho CRM module (for example Leads or Contacts) a Notes action attaches its note to.
\n","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":"\nMap lead and call data to custom values by assigning these Token Value Map Groups to this action.
\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}}}}