Trackdrive API Reference
\n","copyright":null,"doc_url":"/api/docs/1.0","api_url":"/api","resources":{"text_message_flows":{"doc_url":"/api/docs/1.0/text_message_flows","id":"text_message_flows","api_url":"/api","name":"SMS Flow","short_description":"API resource for managing SMS Flow.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/text_message_flows/index","name":"index","apis":[{"api_url":"/api/v1/text_message_flows","http_method":"GET","short_description":"List SMS Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\nParse Value With Expression
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\nValue Formatter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\nValue Expression
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\nUse Flow When Pattern Matches
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"name":"request_a_response","full_name":"request_a_response","description":"\nRequest A Response
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nTranslation missing: en.api.text_message_flows.key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\nAssert Acceptable With Contact Field
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\nResponse Message When Unacceptable
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\nAttribution Token Value Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/create","name":"create","apis":[{"api_url":"/api/v1/text_message_flows","http_method":"POST","short_description":"Create SMS Flow.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\nParse Value With Expression
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\nValue Formatter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\nValue Expression
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\nUse Flow When Pattern Matches
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"name":"request_a_response","full_name":"request_a_response","description":"\nRequest A Response
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nTranslation missing: en.api.text_message_flows.key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\nAssert Acceptable With Contact Field
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\nResponse Message When Unacceptable
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\nAttribution Token Value Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/show","name":"show","apis":[{"api_url":"/api/v1/text_message_flows/:id","http_method":"GET","short_description":"Get SMS Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/update","name":"update","apis":[{"api_url":"/api/v1/text_message_flows/:id","http_method":"PUT","short_description":"Update SMS Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"name":"parse_value_with_expression","full_name":"parse_value_with_expression","description":"\nParse Value With Expression
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\nValue Formatter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_expression","full_name":"value_expression","description":"\nValue Expression
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_flow_when_pattern_matches","full_name":"use_flow_when_pattern_matches","description":"\nUse Flow When Pattern Matches
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"name":"request_a_response","full_name":"request_a_response","description":"\nRequest A Response
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nTranslation missing: en.api.text_message_flows.key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"assert_acceptable_with_contact_field","full_name":"assert_acceptable_with_contact_field","description":"\nAssert Acceptable With Contact Field
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"response_message_when_unacceptable","full_name":"response_message_when_unacceptable","description":"\nResponse Message When Unacceptable
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\nAttribution Token Value Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_message_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/text_message_flows/:id","http_method":"DELETE","short_description":"Destroy SMS Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"text_messages":{"doc_url":"/api/docs/1.0/text_messages","id":"text_messages","api_url":"/api","name":"SMS: Outgoing Text Messages","short_description":"Sends a message by submitting an outbound message request.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/text_messages/create","name":"create","apis":[{"api_url":"/api/v1/text_messages","http_method":"POST","short_description":"Sends a message by submitting an outbound message request.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"from","full_name":"from","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X POST \"trackdrive.com/api/v1/text_messages?message=Thanks+for+your+inquiry&to=%2B16053334444\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/text_messages/index","name":"index","apis":[{"api_url":"/api/v1/text_messages","http_method":"GET","short_description":"Retrieves details about text messages.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Authorize 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Authorize 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/create","name":"create","apis":[{"api_url":"/api/v1/admin_tasks","http_method":"POST","short_description":"Create Admin Task.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/show","name":"show","apis":[{"api_url":"/api/v1/admin_tasks/:id","http_method":"GET","short_description":"Get Admin Task by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/update","name":"update","apis":[{"api_url":"/api/v1/admin_tasks/:id","http_method":"PUT","short_description":"Update Admin Task by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/admin_tasks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/admin_tasks/:id","http_method":"DELETE","short_description":"Destroy Admin Task by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_token","full_name":"auth_token","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"agent_call_dispositions":{"doc_url":"/api/docs/1.0/agent_call_dispositions","id":"agent_call_dispositions","api_url":"/api","name":"Agents / Call Dispositions","short_description":"API resource for managing Agent Call Disposition.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_call_dispositions/index","name":"index","apis":[{"api_url":"/api/v1/agent_call_dispositions","http_method":"GET","short_description":"List Agent Call Disposition records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Call 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":[]},{"name":"notes","full_name":"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_call_dispositions/show","name":"show","apis":[{"api_url":"/api/v1/agent_call_dispositions/:id","http_method":"GET","short_description":"Get Agent Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_call_dispositions/update","name":"update","apis":[{"api_url":"/api/v1/agent_call_dispositions/:id","http_method":"PUT","short_description":"Update Agent Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_disposition_id","full_name":"call_disposition_id","description":"\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":[]},{"name":"notes","full_name":"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_call_dispositions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/agent_call_dispositions/:id","http_method":"DELETE","short_description":"Destroy Agent Call Disposition by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"agent_messages":{"doc_url":"/api/docs/1.0/agent_messages","id":"agent_messages","api_url":"/api","name":"Agent Message","short_description":"API resource for managing Agent Message.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_messages/index","name":"index","apis":[{"api_url":"/api/v1/agent_messages","http_method":"GET","short_description":"List Agent Message records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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_statuses":{"doc_url":"/api/docs/1.0/agent_statuses","id":"agent_statuses","api_url":"/api","name":"Agents: Statuses","short_description":"API resource for managing Agent Statuses.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_statuses/index","name":"index","apis":[{"api_url":"/api/v1/agent_statuses","http_method":"GET","short_description":"List Agent Status records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"name":"hint","full_name":"hint","description":"\nHint
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\nText Color
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\nBackground Color
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pause_agent","full_name":"pause_agent","description":"\nTranslation missing: en.api.agent_statuses.pause_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":[]},{"name":"unpause_agent","full_name":"unpause_agent","description":"\nTranslation missing: en.api.agent_statuses.unpause_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":[]},{"name":"agent_billable","full_name":"agent_billable","description":"\nTranslation missing: en.api.agent_statuses.agent_billable
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\nTranslation missing: en.api.agent_statuses.schedule_action_group_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/create","name":"create","apis":[{"api_url":"/api/v1/agent_statuses","http_method":"POST","short_description":"Create Agent Status.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\nKey
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\nHint
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\nText Color
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\nBackground Color
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pause_agent","full_name":"pause_agent","description":"\nTranslation missing: en.api.agent_statuses.pause_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":[]},{"name":"unpause_agent","full_name":"unpause_agent","description":"\nTranslation missing: en.api.agent_statuses.unpause_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":[]},{"name":"agent_billable","full_name":"agent_billable","description":"\nTranslation missing: en.api.agent_statuses.agent_billable
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\nTranslation missing: en.api.agent_statuses.schedule_action_group_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/show","name":"show","apis":[{"api_url":"/api/v1/agent_statuses/:id","http_method":"GET","short_description":"Get Agent Status by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/update","name":"update","apis":[{"api_url":"/api/v1/agent_statuses/:id","http_method":"PUT","short_description":"Update Agent Status by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"key","full_name":"key","description":"\nKey
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hint","full_name":"hint","description":"\nHint
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\nText Color
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"background_color","full_name":"background_color","description":"\nBackground Color
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pause_agent","full_name":"pause_agent","description":"\nTranslation missing: en.api.agent_statuses.pause_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":[]},{"name":"unpause_agent","full_name":"unpause_agent","description":"\nTranslation missing: en.api.agent_statuses.unpause_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":[]},{"name":"agent_billable","full_name":"agent_billable","description":"\nTranslation missing: en.api.agent_statuses.agent_billable
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_group_id","full_name":"schedule_action_group_id","description":"\nTranslation missing: en.api.agent_statuses.schedule_action_group_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/agent_statuses/destroy","name":"destroy","apis":[{"api_url":"/api/v1/agent_statuses/:id","http_method":"DELETE","short_description":"Destroy Agent Status by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"agent_timestamps":{"doc_url":"/api/docs/1.0/agent_timestamps","id":"agent_timestamps","api_url":"/api","name":"Agent Timestamp","short_description":"API resource for managing Agent Timestamp.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/agent_timestamps/index","name":"index","apis":[{"api_url":"/api/v1/agent_timestamps","http_method":"GET","short_description":"List Agent Timestamp 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Status System
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"app_configs":{"doc_url":"/api/docs/1.0/app_configs","id":"app_configs","api_url":"/api","name":"App Config","short_description":"API resource for managing App Config.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/app_configs/index","name":"index","apis":[{"api_url":"/api/v1/app_configs","http_method":"GET","short_description":"List App Config records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 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":[]},{"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":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\nThe relation.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 ID for the record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\nThe type of record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\nThe relation.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"open_times","full_name":"open_times","description":"\nDefine the days and hours that are open. EX:
\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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/create","name":"create","apis":[{"api_url":"/api/v1/business_ranges","http_method":"POST","short_description":"Create business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"owner_id","full_name":"owner_id","description":"\nThe ID for the record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\nThe type of record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\nThe relation.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"open_times","full_name":"open_times","description":"\nDefine the days and hours that are open. EX:
\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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/show","name":"show","apis":[{"api_url":"/api/v1/business_ranges/:id","http_method":"GET","short_description":"Show business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/update","name":"update","apis":[{"api_url":"/api/v1/business_ranges/:id","http_method":"PUT","short_description":"Update business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"open_times","full_name":"open_times","description":"\nDefine the days and hours that are open. EX:
\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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/business_ranges/destroy","name":"destroy","apis":[{"api_url":"/api/v1/business_ranges/:id","http_method":"DELETE","short_description":"Destroy business hours","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_conversions":{"doc_url":"/api/docs/1.0/buyer_conversions","id":"buyer_conversions","api_url":"/api","name":"Buyers: Conversions","short_description":"API resource for managing buyer conversions.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_conversions/index","name":"index","apis":[{"api_url":"/api/v1/buyer_conversions","http_method":"GET","short_description":"List buyer conversions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\nReturn records matching these ids.
\n","required":true,"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 ID for the record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\nThe type of record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\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":[]},{"name":"conversion_type","full_name":"conversion_type","description":"\nConfigure static or dynamic revenue.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:revenue, webhook, postback.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"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":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_min","full_name":"revenue_min","description":"\nThe minimum valid revenue for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_max","full_name":"revenue_max","description":"\nThe maximum valid revenue for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_increment","full_name":"revenue_increment","description":"\nBids must be increased/decreased by this amount for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duration","full_name":"duration","description":"\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":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"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":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\nTranslation missing: en.api.buyer_conversions.webhook_type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:elocal, media_alpha, marchex, marchex_v2, jornaya_tcpa_guardian, custom.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_url
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_method
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_body
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_headers
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\nHow many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_limit","full_name":"webhook_response_buyers_limit","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_limit
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_by","full_name":"webhook_response_buyers_order_by","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_order_by
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:revenue, duration.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_dir","full_name":"webhook_response_buyers_order_dir","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/create","name":"create","apis":[{"api_url":"/api/v1/buyer_conversions","http_method":"POST","short_description":"Create a buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"owner_id","full_name":"owner_id","description":"\nThe ID for the record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"owner_type","description":"\nThe type of record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\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":[]},{"name":"conversion_type","full_name":"conversion_type","description":"\nConfigure static or dynamic revenue.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:revenue, webhook, postback.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"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":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_min","full_name":"revenue_min","description":"\nThe minimum valid revenue for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_max","full_name":"revenue_max","description":"\nThe maximum valid revenue for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_increment","full_name":"revenue_increment","description":"\nBids must be increased/decreased by this amount for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duration","full_name":"duration","description":"\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":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"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":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\nTranslation missing: en.api.buyer_conversions.webhook_type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:elocal, media_alpha, marchex, marchex_v2, jornaya_tcpa_guardian, custom.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_url
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_method
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_body
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_headers
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\nHow many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_limit","full_name":"webhook_response_buyers_limit","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_limit
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_by","full_name":"webhook_response_buyers_order_by","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_order_by
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:revenue, duration.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_dir","full_name":"webhook_response_buyers_order_dir","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/show","name":"show","apis":[{"api_url":"/api/v1/buyer_conversions/:id","http_method":"GET","short_description":"Show the details of a buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/update","name":"update","apis":[{"api_url":"/api/v1/buyer_conversions/:id","http_method":"PUT","short_description":"Update a buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\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":[]},{"name":"conversion_type","full_name":"conversion_type","description":"\nConfigure static or dynamic revenue.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:revenue, webhook, postback.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue","full_name":"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":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_min","full_name":"revenue_min","description":"\nThe minimum valid revenue for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_max","full_name":"revenue_max","description":"\nThe maximum valid revenue for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"revenue_increment","full_name":"revenue_increment","description":"\nBids must be increased/decreased by this amount for the current time frame.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duration","full_name":"duration","description":"\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":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"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":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_type","full_name":"webhook_type","description":"\nTranslation missing: en.api.buyer_conversions.webhook_type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:elocal, media_alpha, marchex, marchex_v2, jornaya_tcpa_guardian, custom.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_url
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_method
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_body
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\nTranslation missing: en.api.buyer_conversions.webhook_remote_headers
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\nHow many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_limit","full_name":"webhook_response_buyers_limit","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_limit
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_by","full_name":"webhook_response_buyers_order_by","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_order_by
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:revenue, duration.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_buyers_order_dir","full_name":"webhook_response_buyers_order_dir","description":"\nTranslation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:desc, asc.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_conversions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_conversions/:id","http_method":"DELETE","short_description":"Delete a buyer conversion","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_groups":{"doc_url":"/api/docs/1.0/buyer_groups","id":"buyer_groups","api_url":"/api","name":"Buyer Group","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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/buyer_groups?page=1&order=created_at&\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_groups/show","name":"show","apis":[{"api_url":"/api/v1/buyer_groups/:id","http_method":"GET","short_description":"Get an individual Buyer Group by id","deprecated":null}],"formats":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/:id","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":[]},{"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":[]},{"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":[]},{"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.
Grant 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"name \":\"Great Group Of Buyers\", \"buyer_ids\": [100123,100124]}' https://[your-subdomain].trackdrive.com/api/v1/buyer_groups"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_groups/update","name":"update","apis":[{"api_url":"/api/v1/buyer_groups/:id","http_method":"PUT","short_description":"Update an individual Buyer Group","deprecated":null}],"formats":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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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.
Grant 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"name \":\"Great Group Of Buyers\", \"add_buyer_ids\": [100123,100124], \"remove_buyer_ids\": [100101]}' https://[your-subdomain].trackdrive.com/api/v1/buyer_groups/123456"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_groups/:id","http_method":"DELETE","short_description":"Destroy an individual Buyer Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE https://[your-subdomain].trackdrive.com/api/v1/buyer_groups/:id"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_ping_parser_paths":{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths","id":"buyer_ping_parser_paths","api_url":"/api","name":"Parsing Path","short_description":"API resource for managing Parsing Path.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/index","name":"index","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths","http_method":"GET","short_description":"List Parsing Path records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Buyer Ping Parser
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\nValue Path
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nKey
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/create","name":"create","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths","http_method":"POST","short_description":"Create Parsing Path.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"buyer_ping_parser_id","full_name":"buyer_ping_parser_id","description":"\nBuyer Ping Parser
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\nValue Path
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nKey
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/show","name":"show","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths/:id","http_method":"GET","short_description":"Get Parsing Path by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/update","name":"update","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths/:id","http_method":"PUT","short_description":"Update Parsing Path by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"buyer_ping_parser_id","full_name":"buyer_ping_parser_id","description":"\nBuyer Ping Parser
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\nValue Path
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nKey
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parser_paths/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_ping_parser_paths/:id","http_method":"DELETE","short_description":"Destroy Parsing Path by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_ping_parsers":{"doc_url":"/api/docs/1.0/buyer_ping_parsers","id":"buyer_ping_parsers","api_url":"/api","name":"Extract Custom Buyer Attribute","short_description":"API resource for managing Extract Custom Buyer Attribute.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_ping_parsers/index","name":"index","apis":[{"api_url":"/api/v1/buyer_ping_parsers","http_method":"GET","short_description":"List Extract Custom Buyer Attribute records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/create","name":"create","apis":[{"api_url":"/api/v1/buyer_ping_parsers","http_method":"POST","short_description":"Create Extract Custom Buyer Attribute.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/show","name":"show","apis":[{"api_url":"/api/v1/buyer_ping_parsers/:id","http_method":"GET","short_description":"Get Extract Custom Buyer Attribute by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/update","name":"update","apis":[{"api_url":"/api/v1/buyer_ping_parsers/:id","http_method":"PUT","short_description":"Update Extract Custom Buyer Attribute by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_ping_parsers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_ping_parsers/:id","http_method":"DELETE","short_description":"Destroy Extract Custom Buyer Attribute by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_suppression_files":{"doc_url":"/api/docs/1.0/buyer_suppression_files","id":"buyer_suppression_files","api_url":"/api","name":"Suppression File","short_description":"API resource for managing Suppression File.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_suppression_files/index","name":"index","apis":[{"api_url":"/api/v1/buyer_suppression_files","http_method":"GET","short_description":"List Suppression File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_suppressions_contacts":{"doc_url":"/api/docs/1.0/buyer_suppressions_contacts","id":"buyer_suppressions_contacts","api_url":"/api","name":"Buyer Suppression Caller","short_description":"API resource for managing Buyer Suppression Caller.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_suppressions_contacts/index","name":"index","apis":[{"api_url":"/api/v1/buyer_suppressions_contacts","http_method":"GET","short_description":"List Buyer Suppression Caller records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyer_suppressions":{"doc_url":"/api/docs/1.0/buyer_suppressions","id":"buyer_suppressions","api_url":"/api","name":"Suppression Lists","short_description":"API resource for managing suppression lists on offers, schedules, and buyers.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/buyer_suppressions/index","name":"index","apis":[{"api_url":"/api/v1/buyer_suppressions","http_method":"GET","short_description":"List suppression lists.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyer_suppressions/:id","http_method":"DELETE","short_description":"Destroy suppression list by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/caller_block","name":"caller_block","apis":[{"api_url":"/api/v1/buyer_suppressions/:id/caller_block","http_method":"POST","short_description":"Add individual phone numbers to a suppression list.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_ids","full_name":"caller_ids","description":"\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":[]}],"returns":[],"examples":["curl -H \"Content-Type: application/json\" -X POST -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -d '{\"caller_ids\": [\"17191231234\",\"17191231235\"]}' \"https://[your-subdomain].trackdrive.com/api/v1/buyer_suppressions/:id/caller_block\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyer_suppressions/caller_unblock","name":"caller_unblock","apis":[{"api_url":"/api/v1/buyer_suppressions/:id/caller_unblock","http_method":"POST","short_description":"Remove individual phone numbers from a suppression list.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_ids","full_name":"caller_ids","description":"\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":[]}],"returns":[],"examples":["curl -H \"Content-Type: application/json\" -X POST -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -d '{\"caller_ids\": [\"17191231234\",\"17191231235\"]}' \"https://[your-subdomain].trackdrive.com/api/v1/buyer_suppressions/:id/caller_unblock\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buyers":{"doc_url":"/api/docs/1.0/buyers","id":"buyers","api_url":"/api","name":"Buyers","short_description":"API resource for managing Buyer.","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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" https://[your-subdomain].trackdrive.com/api/v1/buyers"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/show","name":"show","apis":[{"api_url":"/api/v1/buyers/:id","http_method":"GET","short_description":"Get a buyer record by 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. |
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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"name":"buyer_suppression_ids","full_name":"buyer_suppression_ids","description":"\nThe 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"tier\":\"-10\",\"name\":\"new name\"}' https://[your-subdomain].trackdrive.com/api/v1/buyers/:id"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/new","name":"new","apis":[{"api_url":"/api/v1/buyers/new","http_method":"GET","short_description":"Build buyer with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"name":"buyer_suppression_ids","full_name":"buyer_suppression_ids","description":"\nThe 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"name\":\"Call Centre 1\", \"number\": \"+18004457682\"}' https://[your-subdomain].trackdrive.com/api/v1/buyers"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/buyers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/buyers/:id","http_method":"DELETE","short_description":"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_centers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_centers/:id","http_method":"DELETE","short_description":"Destroy Call Center by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_control_actions":{"doc_url":"/api/docs/1.0/call_control_actions","id":"call_control_actions","api_url":"/api","name":"Agents: Call Actions","short_description":"API resource for managing Call Action.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_control_actions/index","name":"index","apis":[{"api_url":"/api/v1/call_control_actions","http_method":"GET","short_description":"List Call Action records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_control_actions/:id","http_method":"DELETE","short_description":"Destroy Call Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_dispositions":{"doc_url":"/api/docs/1.0/call_dispositions","id":"call_dispositions","api_url":"/api","name":"Agents: Call Dispositions","short_description":"API resource for managing Call Disposition.","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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/create","name":"create","apis":[{"api_url":"/api/v1/call_dispositions","http_method":"POST","short_description":"Create 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/show","name":"show","apis":[{"api_url":"/api/v1/call_dispositions/:id","http_method":"GET","short_description":"Get 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_dispositions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_dispositions/:id","http_method":"DELETE","short_description":"Destroy 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":"Calls: Logs","short_description":"Get the logs for a call.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_logs/index","name":"index","apis":[{"api_url":"/api/v1/call_logs","http_method":"GET","short_description":"Get the logs for a call.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_id","full_name":"call_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"root","full_name":"root","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"name":"outgoing_webhook_ids","full_name":"outgoing_webhook_ids","description":"\nOutgoing Webhook Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\nStatus
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_modifications/create","name":"create","apis":[{"api_url":"/api/v1/call_modifications","http_method":"POST","short_description":"Create Call Modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\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":[]},{"name":"outgoing_webhook_ids","full_name":"outgoing_webhook_ids","description":"\nOutgoing Webhook Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\nStatus
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_modifications/show","name":"show","apis":[{"api_url":"/api/v1/call_modifications/:id","http_method":"GET","short_description":"Get Call Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_modifications/update","name":"update","apis":[{"api_url":"/api/v1/call_modifications/:id","http_method":"PUT","short_description":"Update Call Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\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":[]},{"name":"outgoing_webhook_ids","full_name":"outgoing_webhook_ids","description":"\nOutgoing Webhook Ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\nStatus
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_modifications/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_modifications/:id","http_method":"DELETE","short_description":"Destroy Call Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_recording_rules":{"doc_url":"/api/docs/1.0/call_recording_rules","id":"call_recording_rules","api_url":"/api","name":"Calls: Recording Retention","short_description":"API resource for managing Call Recording Retention.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_recording_rules/index","name":"index","apis":[{"api_url":"/api/v1/call_recording_rules","http_method":"GET","short_description":"List Call Recording Retention records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_recording_rules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_recording_rules/:id","http_method":"DELETE","short_description":"Destroy Call Recording Retention by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_router_answer_groups":{"doc_url":"/api/docs/1.0/call_router_answer_groups","id":"call_router_answer_groups","api_url":"/api","name":"Offers: Call Flow: Answer Groups","short_description":"API resource for managing Call Flow Answer Groups.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_router_answer_groups/index","name":"index","apis":[{"api_url":"/api/v1/call_router_answer_groups","http_method":"GET","short_description":"List Answer Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\nTranslation missing: en.api.call_router_answer_groups.call_router_answers_count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answer_groups/create","name":"create","apis":[{"api_url":"/api/v1/call_router_answer_groups","http_method":"POST","short_description":"Create Answer Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\nTranslation missing: en.api.call_router_answer_groups.call_router_answers_count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answer_groups/show","name":"show","apis":[{"api_url":"/api/v1/call_router_answer_groups/:id","http_method":"GET","short_description":"Get Answer Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answer_groups/update","name":"update","apis":[{"api_url":"/api/v1/call_router_answer_groups/:id","http_method":"PUT","short_description":"Update Answer Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_answers_count","full_name":"call_router_answers_count","description":"\nTranslation missing: en.api.call_router_answer_groups.call_router_answers_count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answer_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_router_answer_groups/:id","http_method":"DELETE","short_description":"Destroy Answer Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_router_answers":{"doc_url":"/api/docs/1.0/call_router_answers","id":"call_router_answers","api_url":"/api","name":"Offers: Call Flow: Answers","short_description":"API resource for managing Call Flow Answers.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_router_answers/index","name":"index","apis":[{"api_url":"/api/v1/call_router_answers","http_method":"GET","short_description":"List Answer records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.call_router_answers.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\nAdditional Tokens
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\nTranslation missing: en.api.call_router_answers.attribution_token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answers/create","name":"create","apis":[{"api_url":"/api/v1/call_router_answers","http_method":"POST","short_description":"Create Answer.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_router_answer_group_id","full_name":"call_router_answer_group_id","description":"\nAnswer Group
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_press","full_name":"key_press","description":"\nKey Press
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\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":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.call_router_answers.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\nAdditional Tokens
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\nTranslation missing: en.api.call_router_answers.attribution_token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answers/show","name":"show","apis":[{"api_url":"/api/v1/call_router_answers/:id","http_method":"GET","short_description":"Get Answer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answers/update","name":"update","apis":[{"api_url":"/api/v1/call_router_answers/:id","http_method":"PUT","short_description":"Update Answer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_router_answer_group_id","full_name":"call_router_answer_group_id","description":"\nAnswer Group
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_press","full_name":"key_press","description":"\nKey Press
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\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":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.call_router_answers.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\nAdditional Tokens
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attribution_token_value_ids","full_name":"attribution_token_value_ids","description":"\nTranslation missing: en.api.call_router_answers.attribution_token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_router_answers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_router_answers/:id","http_method":"DELETE","short_description":"Destroy Answer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"call_routers":{"doc_url":"/api/docs/1.0/call_routers","id":"call_routers","api_url":"/api","name":"Offers: Call Flow","short_description":"API resource for managing Call Flow. This resource is used to manage rules for Call Handling, Exception Handling, and Hold Queue Handling.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_routers/index","name":"index","apis":[{"api_url":"/api/v1/call_routers","http_method":"GET","short_description":"List Call Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 |
| 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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.
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":[]},{"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 |
| when_answering_machine_detected | When 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 |
| 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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.
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":[]},{"name":"message_type","full_name":"message_type","description":"\nPlay 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 |
| 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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.
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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls?page=1&in_progress=true&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/index_by_caller_number","name":"index_by_caller_number","apis":[{"api_url":"/api/v1/calls/:caller_number/by_caller_number","http_method":"GET","short_description":"List calls by caller number.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/17191231234/by_caller_number\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/live_calls","name":"live_calls","apis":[{"api_url":"/api/v1/calls/live_calls","http_method":"GET","short_description":"List ongoing live calls.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/reports?category=buyer_id&\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/stats","name":"stats","apis":[{"api_url":"/api/v1/calls/stats","http_method":"GET","short_description":"Get statistics on calls by category and interval.","deprecated":null}],"formats":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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/calls/stats/?group_by=status&created_at_from=2025-07-12 20:40:31 UTC&created_at_to=2025-07-13 08:40:31 +0000&stat=count\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/create","name":"create","apis":[{"api_url":"/api/v1/calls","http_method":"POST","short_description":"Make an outbound phone call.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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
Call ID or Call UUID with contact fields, revenue, payout, and more.","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
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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"post_call_tokens\": {\"good_lead\":\"yes\",\"loan_amount\":\"500\"}}' https://[your-subdomain].trackdrive.com/api/v1/calls/:id"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/update_by_caller_id","name":"update_by_caller_id","apis":[{"api_url":"/api/v1/calls/update_by_caller_id/:caller_id","http_method":"POST","short_description":"Update a call's revenue and buyer_converted using the call'scaller_id and offer_token","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_id","full_name":"caller_id","description":"\nThe 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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"add_revenue\": 2.50, \"buyer_converted\": \"true\"}' https://[your-subdomain].trackdrive.com/api/v1/calls/update_by_caller_id/:caller_id","curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X POST \"https://my-company.trackdrive.com/api/v1/calls/update_by_caller_id/17194448888?offer_token=the-offer-token&add_revenue=5\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/calls/send_key_press","name":"send_key_press","apis":[{"api_url":"/api/v1/calls/send_key_press","http_method":"POST","short_description":"Send a Key Press to trigger a key press flow.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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_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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"companies":{"doc_url":"/api/docs/1.0/companies","id":"companies","api_url":"/api","name":"Your Companies","short_description":"API resource for viewing the Trackdrive Companies you can access.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/companies/index","name":"index","apis":[{"api_url":"/api/v1/companies","http_method":"GET","short_description":"List the Trackdrive Companies you can access.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Public Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"private_key","full_name":"private_key","description":"\nPrivate Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_used_at","full_name":"last_used_at","description":"\nLast Used At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"permissions","full_name":"permissions","description":"\nPermissions
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/create","name":"create","apis":[{"api_url":"/api/v1/company_access_tokens","http_method":"POST","short_description":"Create Access Tokens.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"public_key","full_name":"public_key","description":"\nPublic Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"private_key","full_name":"private_key","description":"\nPrivate Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_used_at","full_name":"last_used_at","description":"\nLast Used At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"permissions","full_name":"permissions","description":"\nPermissions
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/show","name":"show","apis":[{"api_url":"/api/v1/company_access_tokens/:id","http_method":"GET","short_description":"Get Access Tokens by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/update","name":"update","apis":[{"api_url":"/api/v1/company_access_tokens/:id","http_method":"PUT","short_description":"Update Access Tokens by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"public_key","full_name":"public_key","description":"\nPublic Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"private_key","full_name":"private_key","description":"\nPrivate Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_used_at","full_name":"last_used_at","description":"\nLast Used At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"permissions","full_name":"permissions","description":"\nPermissions
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/v1/company_access_tokens/:id","http_method":"DELETE","short_description":"Destroy Access Tokens by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"company_dialler_processors":{"doc_url":"/api/docs/1.0/company_dialler_processors","id":"company_dialler_processors","api_url":"/api","name":"Power Dialer","short_description":"API resource for managing Power Dialer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/company_dialler_processors/show","name":"show","apis":[{"api_url":"/api/v1/company_dialler_processors/:id","http_method":"GET","short_description":"Get Power Dialer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/company_dialler_processors/update","name":"update","apis":[{"api_url":"/api/v1/company_dialler_processors/:id","http_method":"PUT","short_description":"Translation missing: en.api.company_dialler_processors.update","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"company_feature_fields":{"doc_url":"/api/docs/1.0/company_feature_fields","id":"company_feature_fields","api_url":"/api","name":"Feature","short_description":"API resource for managing Feature.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/company_feature_fields/index","name":"index","apis":[{"api_url":"/api/v1/company_feature_fields","http_method":"GET","short_description":"List Feature records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Translation missing: en.api.contact_field_values.contact_field_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Contact Field}[/api/docs/1.0/contact_fields/index.html]. Refer to: {/api/docs/1.0/contact_fields}[/api/docs/1.0/contact_fields/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/create","name":"create","apis":[{"api_url":"/api/v1/contact_field_values","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"contact_field_id","full_name":"contact_field_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/show","name":"show","apis":[{"api_url":"/api/v1/contact_field_values/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/update","name":"update","apis":[{"api_url":"/api/v1/contact_field_values/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"contact_field_id","full_name":"contact_field_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_values/destroy","name":"destroy","apis":[{"api_url":"/api/v1/contact_field_values/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contact_field_views":{"doc_url":"/api/docs/1.0/contact_field_views","id":"contact_field_views","api_url":"/api","name":"Offers: Agent Scripts","short_description":"API resource for managing an offer's agent scripts.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contact_field_views/index","name":"index","apis":[{"api_url":"/api/v1/contact_field_views","http_method":"GET","short_description":"List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\nTranslation missing: en.api.contact_field_views.offer_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/create","name":"create","apis":[{"api_url":"/api/v1/contact_field_views","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"title","full_name":"title","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/show","name":"show","apis":[{"api_url":"/api/v1/contact_field_views/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/update","name":"update","apis":[{"api_url":"/api/v1/contact_field_views/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_field_views/destroy","name":"destroy","apis":[{"api_url":"/api/v1/contact_field_views/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contact_fields":{"doc_url":"/api/docs/1.0/contact_fields","id":"contact_fields","api_url":"/api","name":"Offers: Contact Fields","short_description":"API resource for managing an offer's contact fields.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contact_fields/index","name":"index","apis":[{"api_url":"/api/v1/contact_fields","http_method":"GET","short_description":"List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/create","name":"create","apis":[{"api_url":"/api/v1/contact_fields","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/show","name":"show","apis":[{"api_url":"/api/v1/contact_fields/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/update","name":"update","apis":[{"api_url":"/api/v1/contact_fields/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contact_fields/destroy","name":"destroy","apis":[{"api_url":"/api/v1/contact_fields/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contact_imports":{"doc_url":"/api/docs/1.0/contact_imports","id":"contact_imports","api_url":"/api","name":"Blacklist: Files","short_description":"API resource for uploading blacklist files.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contact_imports/index","name":"index","apis":[{"api_url":"/api/v1/contact_imports","http_method":"GET","short_description":"List Blacklist File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"name":"import_file","full_name":"import_file","description":"\nTranslation missing: en.api.contact_imports.import_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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"name":"import_file","full_name":"import_file","description":"\nTranslation missing: en.api.contact_imports.import_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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"name":"import_file","full_name":"import_file","description":"\nTranslation missing: en.api.contact_imports.import_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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"contacts":{"doc_url":"/api/docs/1.0/contacts","id":"contacts","api_url":"/api","name":"Contacts & Blacklist","short_description":"The contacts that have dialed your numbers.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/contacts/index_suppression_list","name":"index_suppression_list","apis":[{"api_url":"/api/v1/contacts/suppression_list","http_method":"GET","short_description":"List contacts on your company blacklist.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Lookup 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":[]}],"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":[]},{"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":[]}],"returns":[],"examples":["\ncurl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X PUT \"trackdrive.com/api/v1/contacts/18551231234?blocked=true\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/contacts/hang_up_calls","name":"hang_up_calls","apis":[{"api_url":"/api/v1/contacts/:id/calls","http_method":"DELETE","short_description":"Hang up all the ongoing calls from a contact.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"uuid","full_name":"uuid","description":"\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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -i -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/contacts/123/calls?\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"data_append_groups":{"doc_url":"/api/docs/1.0/data_append_groups","id":"data_append_groups","api_url":"/api","name":"Data Append Group","short_description":"API resource for managing Data Append Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/data_append_groups/index","name":"index","apis":[{"api_url":"/api/v1/data_append_groups","http_method":"GET","short_description":"List Data Append Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_append_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/data_append_groups/:id","http_method":"DELETE","short_description":"Destroy Data Append Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"data_appends":{"doc_url":"/api/docs/1.0/data_appends","id":"data_appends","api_url":"/api","name":"Data Append","short_description":"API resource for appending data. This incurs a per API request usage charge on your company.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/data_appends/index","name":"index","apis":[{"api_url":"/api/v1/data_appends","http_method":"GET","short_description":"List of data appends.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/destroy","name":"destroy","apis":[{"api_url":"/api/v1/data_appends/:id","http_method":"DELETE","short_description":"Destroy a data append.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/data_appends/append","name":"append","apis":[{"api_url":"/api/v1/data_append","http_method":"POST","short_description":"Request data for caller number. This incurs a per API request usage charge on your company based on data type requested.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_number","full_name":"caller_number","description":"\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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["# Submit data append request as JSON:\ncurl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -X POST \\\n -d '{\"caller_id\":\"+18004506787\",\"fetch_type\":\"address\"}' \\\n \"https://[your-subdomain].trackdrive.com/api/v1/data_append\"\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"data_export_records":{"doc_url":"/api/docs/1.0/data_export_records","id":"data_export_records","api_url":"/api","name":"Data Exports: Parts","short_description":"API resource for managing Data Export Parts.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/data_export_records/index","name":"index","apis":[{"api_url":"/api/v1/data_export_records","http_method":"GET","short_description":"List Data Export Parts records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Date 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":[]},{"name":"to","full_name":"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":[]},{"name":"rollup_period","full_name":"rollup_period","description":"\nThe interval.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rollup_aggregator","full_name":"rollup_aggregator","description":"\nThe function to apply to the result set.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:sum, min, max, avg.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"queries","full_name":"queries","description":"\nTranslation missing: en.api.datasets.queries
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a a valid array of queries.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"series_calc_function","full_name":"series_calc_function","description":"\nTranslation missing: en.api.datasets.series_calc_function
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:timeseries, sum, avg, min, max.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"html_links","full_name":"html_links","description":"\nTranslation missing: en.api.datasets.html_links
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/datasets/calls","name":"calls","apis":[{"api_url":"/api/v1/datasets/calls/:stat","http_method":"GET","short_description":"Get call datasets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"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:buyer_converted_count, offer_converted_count.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_format","full_name":"data_format","description":"\nTranslation missing: en.api.data_format
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:timeseries, sum.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\nA timeframe
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:300, 600, 1200, 3600, 86400, 2629746.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/datasets/leads","name":"leads","apis":[{"api_url":"/api/v1/datasets/leads/:stat","http_method":"GET","short_description":"Get call datasets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"stat","full_name":"stat","description":"\nTranslation missing: en.api.leads.stat
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:has_next_action_count, buyer_converted_count, offer_converted_count.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"data_format","full_name":"data_format","description":"\nTranslation missing: en.api.data_format
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:timeseries, sum.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\nA timeframe
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:300, 600, 1200, 3600, 86400, 2629746.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/datasets/billing","name":"billing","apis":[{"api_url":"/api/v1/datasets/billing","http_method":"GET","short_description":"Get the billing dataset","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"data_format","full_name":"data_format","description":"\nTranslation missing: en.api.data_format
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:timeseries, sum.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\nA timeframe
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:300, 600, 1200, 3600, 86400, 2629746.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/datasets/number_impressions","name":"number_impressions","apis":[{"api_url":"/api/v1/datasets/number_impressions","http_method":"GET","short_description":"Get the number impression dataset","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"data_format","full_name":"data_format","description":"\nTranslation missing: en.api.data_format
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:timeseries, sum.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\nA timeframe
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:300, 600, 1200, 3600, 86400, 2629746.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dnc_check_logs":{"doc_url":"/api/docs/1.0/dnc_check_logs","id":"dnc_check_logs","api_url":"/api","name":"DNC Check Log","short_description":"API resource for managing DNC Check Log.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/dnc_check_logs/index","name":"index","apis":[{"api_url":"/api/v1/dnc_check_logs","http_method":"GET","short_description":"List DNC Check 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 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":[]},{"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":[]},{"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":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\nTranslation missing: en.api.filter_group_items.record_token_filter_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.filter_group_items.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/create","name":"create","apis":[{"api_url":"/api/v1/filter_group_items","http_method":"POST","short_description":"Create Filter Set Rule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"filter_group_id","full_name":"filter_group_id","description":"\nFilter 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":[]},{"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":[]},{"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":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\nTranslation missing: en.api.filter_group_items.record_token_filter_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.filter_group_items.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/show","name":"show","apis":[{"api_url":"/api/v1/filter_group_items/:id","http_method":"GET","short_description":"Get Filter Set Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/update","name":"update","apis":[{"api_url":"/api/v1/filter_group_items/:id","http_method":"PUT","short_description":"Update Filter Set Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"filter_group_id","full_name":"filter_group_id","description":"\nFilter 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":[]},{"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":[]},{"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":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\nTranslation missing: en.api.filter_group_items.record_token_filter_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.filter_group_items.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_group_items/destroy","name":"destroy","apis":[{"api_url":"/api/v1/filter_group_items/:id","http_method":"DELETE","short_description":"Destroy Filter Set Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"filter_groups":{"doc_url":"/api/docs/1.0/filter_groups","id":"filter_groups","api_url":"/api","name":"Filter Set","short_description":"API resource for managing Filter Set.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/filter_groups/index","name":"index","apis":[{"api_url":"/api/v1/filter_groups","http_method":"GET","short_description":"List Filter Set records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/create","name":"create","apis":[{"api_url":"/api/v1/filter_groups","http_method":"POST","short_description":"Create Filter Set.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/show","name":"show","apis":[{"api_url":"/api/v1/filter_groups/:id","http_method":"GET","short_description":"Get Filter Set by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/update","name":"update","apis":[{"api_url":"/api/v1/filter_groups/:id","http_method":"PUT","short_description":"Update Filter Set by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/filter_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/filter_groups/:id","http_method":"DELETE","short_description":"Destroy Filter Set by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"firewall_rules":{"doc_url":"/api/docs/1.0/firewall_rules","id":"firewall_rules","api_url":"/api","name":"Firewall Rule","short_description":"API resource for managing Firewall Rule.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/firewall_rules/index","name":"index","apis":[{"api_url":"/api/v1/firewall_rules","http_method":"GET","short_description":"List Firewall Rule records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/impressions.csv?&created_at_from=2025-07-06\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"inbound_webhook_logs":{"doc_url":"/api/docs/1.0/inbound_webhook_logs","id":"inbound_webhook_logs","api_url":"/api","name":"Offers: Incoming Webhooks: Logs","short_description":"API resource for managing Ping/Post Logs.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/inbound_webhook_logs/index","name":"index","apis":[{"api_url":"/api/v1/inbound_webhook_logs","http_method":"GET","short_description":"List Ping/Post Logs records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/post","name":"post","apis":[{"api_url":"/api/v1/inbound_webhooks/post/:vanity_uri","http_method":"POST","short_description":"POST with a ping_id to retrieve a tracking number for forwarding an inbound call to a matching buyer.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"vanity_uri","full_name":"vanity_uri","description":"\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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/inbound_webhooks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/inbound_webhooks/:id","http_method":"DELETE","short_description":"Destroy Incoming Webhook by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"incoming_text_messages":{"doc_url":"/api/docs/1.0/incoming_text_messages","id":"incoming_text_messages","api_url":"/api","name":"SMS: Incoming Text Messages","short_description":"API resource for managing Incoming Text Message.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/incoming_text_messages/index","name":"index","apis":[{"api_url":"/api/v1/incoming_text_messages","http_method":"GET","short_description":"List Incoming Text Message records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]}],"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:google_adwords, typeform, pagerduty, zoho_crm, tcpa_shield, salesforce, slack, facebook_leadads, blacklist_alliance, zadarma, infusionsoft, mailchimp, mailgun, sendgrid.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/create","name":"create","apis":[{"api_url":"/api/v1/integrations","http_method":"POST","short_description":"Create Integration.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"integration_type","full_name":"integration_type","description":"\nIntegration Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:google_adwords, typeform, pagerduty, zoho_crm, tcpa_shield, salesforce, slack, facebook_leadads, blacklist_alliance, zadarma, infusionsoft, mailchimp, mailgun, sendgrid.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/show","name":"show","apis":[{"api_url":"/api/v1/integrations/:id","http_method":"GET","short_description":"Get Integration by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/update","name":"update","apis":[{"api_url":"/api/v1/integrations/:id","http_method":"PUT","short_description":"Update Integration by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"integration_type","full_name":"integration_type","description":"\nIntegration Type
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:google_adwords, typeform, pagerduty, zoho_crm, tcpa_shield, salesforce, slack, facebook_leadads, blacklist_alliance, zadarma, infusionsoft, mailchimp, mailgun, sendgrid.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/integrations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/integrations/:id","http_method":"DELETE","short_description":"Destroy Integration by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"key_press_flow_groups":{"doc_url":"/api/docs/1.0/key_press_flow_groups","id":"key_press_flow_groups","api_url":"/api","name":"Offers: Key Press Flow Group","short_description":"API resource for managing Key Press Flow Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/key_press_flow_groups/index","name":"index","apis":[{"api_url":"/api/v1/key_press_flow_groups","http_method":"GET","short_description":"List Key Press Flow Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flow_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/key_press_flow_groups/:id","http_method":"DELETE","short_description":"Destroy Key Press Flow Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"key_press_flows":{"doc_url":"/api/docs/1.0/key_press_flows","id":"key_press_flows","api_url":"/api","name":"Offers: Key Press Flow","short_description":"API resource for managing Key Press Flow.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/key_press_flows/index","name":"index","apis":[{"api_url":"/api/v1/key_press_flows","http_method":"GET","short_description":"List Key Press Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/key_press_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/key_press_flows/:id","http_method":"DELETE","short_description":"Destroy Key Press Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_alterations":{"doc_url":"/api/docs/1.0/lead_alterations","id":"lead_alterations","api_url":"/api","name":"Schedules: Lead Modifications","short_description":"The configuration for how leads are modified on an lead modification schedule action.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_alterations/index","name":"index","apis":[{"api_url":"/api/v1/lead_alterations","http_method":"GET","short_description":"List lead modifications.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\nTranslation missing: en.api.lead_alterations.schedule_action_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/new","name":"new","apis":[{"api_url":"/api/v1/lead_alterations/new","http_method":"GET","short_description":"Build a lead modification with default attributes.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/create","name":"create","apis":[{"api_url":"/api/v1/lead_alterations","http_method":"POST","short_description":"Create a lead modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\nTranslation missing: en.api.lead_alterations.schedule_action_id
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nTranslation missing: en.api.lead_alterations.key
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operator","full_name":"operator","description":"\nTranslation missing: en.api.lead_alterations.operator
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:set, add_decimal, subtract_decimal, add_string.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\nTranslation missing: en.api.lead_alterations.value
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/show","name":"show","apis":[{"api_url":"/api/v1/lead_alterations/:id","http_method":"GET","short_description":"Get details about a lead modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/update","name":"update","apis":[{"api_url":"/api/v1/lead_alterations/:id","http_method":"PUT","short_description":"Update a lead modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\nTranslation missing: en.api.lead_alterations.schedule_action_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule Action}[/api/docs/1.0/schedule_actions/index.html]. Refer to: {/api/docs/1.0/schedule_actions}[/api/docs/1.0/schedule_actions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nTranslation missing: en.api.lead_alterations.key
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operator","full_name":"operator","description":"\nTranslation missing: en.api.lead_alterations.operator
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:set, add_decimal, subtract_decimal, add_string.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\nTranslation missing: en.api.lead_alterations.value
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_alterations/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_alterations/:id","http_method":"DELETE","short_description":"Destroy a lead modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_imports":{"doc_url":"/api/docs/1.0/lead_imports","id":"lead_imports","api_url":"/api","name":"Lead Import","short_description":"API resource for managing Lead Import.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_imports/index","name":"index","apis":[{"api_url":"/api/v1/lead_imports","http_method":"GET","short_description":"List Lead Import records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
User
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"source_company_id","full_name":"source_company_id","description":"\nSource Company
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_company_id","full_name":"target_company_id","description":"\nTarget Company
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active","full_name":"active","description":"\nActive
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"counter","full_name":"counter","description":"\nCounter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_id","full_name":"last_id","description":"\nLast
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/create","name":"create","apis":[{"api_url":"/api/v1/lead_migrators","http_method":"POST","short_description":"Create Lead Migrator.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\nUser
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"source_company_id","full_name":"source_company_id","description":"\nSource Company
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_company_id","full_name":"target_company_id","description":"\nTarget Company
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active","full_name":"active","description":"\nActive
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"counter","full_name":"counter","description":"\nCounter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_id","full_name":"last_id","description":"\nLast
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/show","name":"show","apis":[{"api_url":"/api/v1/lead_migrators/:id","http_method":"GET","short_description":"Get Lead Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/update","name":"update","apis":[{"api_url":"/api/v1/lead_migrators/:id","http_method":"PUT","short_description":"Update Lead Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\nUser
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"source_company_id","full_name":"source_company_id","description":"\nSource Company
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"target_company_id","full_name":"target_company_id","description":"\nTarget Company
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active","full_name":"active","description":"\nActive
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"counter","full_name":"counter","description":"\nCounter
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_id","full_name":"last_id","description":"\nLast
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:10 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_migrators/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_migrators/:id","http_method":"DELETE","short_description":"Destroy Lead Migrator by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_retarget_logs":{"doc_url":"/api/docs/1.0/lead_retarget_logs","id":"lead_retarget_logs","api_url":"/api","name":"Leads: Retargeting: Logs","short_description":"API resource for accessing Lead Retarget Logs.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_retarget_logs/index","name":"index","apis":[{"api_url":"/api/v1/lead_retarget_logs","http_method":"GET","short_description":"List Lead Retarget Log records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/create","name":"create","apis":[{"api_url":"/api/v1/lead_retargets","http_method":"POST","short_description":"Create Lead Retargeting.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_import_id","full_name":"lead_import_id","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/show","name":"show","apis":[{"api_url":"/api/v1/lead_retargets/:id","http_method":"GET","short_description":"Get Lead Retargeting by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/update","name":"update","apis":[{"api_url":"/api/v1/lead_retargets/:id","http_method":"PUT","short_description":"Update Lead Retargeting by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_import_id","full_name":"lead_import_id","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_retargets/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_retargets/:id","http_method":"DELETE","short_description":"Destroy Lead Retargeting by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_wait_rule_groups":{"doc_url":"/api/docs/1.0/lead_wait_rule_groups","id":"lead_wait_rule_groups","api_url":"/api","name":"Wait Rule Group","short_description":"API resource for managing Wait Rule Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_wait_rule_groups/index","name":"index","apis":[{"api_url":"/api/v1/lead_wait_rule_groups","http_method":"GET","short_description":"List Wait Rule Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rule_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_wait_rule_groups/:id","http_method":"DELETE","short_description":"Destroy Wait Rule Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"lead_wait_rules":{"doc_url":"/api/docs/1.0/lead_wait_rules","id":"lead_wait_rules","api_url":"/api","name":"Wait Rule","short_description":"API resource for managing Wait Rule.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/lead_wait_rules/index","name":"index","apis":[{"api_url":"/api/v1/lead_wait_rules","http_method":"GET","short_description":"List Wait Rule records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/create","name":"create","apis":[{"api_url":"/api/v1/lead_wait_rules","http_method":"POST","short_description":"Create Wait Rule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wait_seconds","full_name":"wait_seconds","description":"\nWait Seconds
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_call_disposition_ids","full_name":"filter_call_disposition_ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/show","name":"show","apis":[{"api_url":"/api/v1/lead_wait_rules/:id","http_method":"GET","short_description":"Get Wait Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/update","name":"update","apis":[{"api_url":"/api/v1/lead_wait_rules/:id","http_method":"PUT","short_description":"Update Wait Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"wait_seconds","full_name":"wait_seconds","description":"\nWait Seconds
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_call_disposition_ids","full_name":"filter_call_disposition_ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/lead_wait_rules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/lead_wait_rules/:id","http_method":"DELETE","short_description":"Destroy Wait Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"leads_agent_dial_actions":{"doc_url":"/api/docs/1.0/leads_agent_dial_actions","id":"leads_agent_dial_actions","api_url":"/api","name":"Leads: Matching Leads Dial Queue","short_description":"List leads that are waiting for a call and match an Instant Agent Call Flow and at least one Buyer.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/leads_agent_dial_actions/index","name":"index","apis":[{"api_url":"/api/v1/leads_agent_dial_actions","http_method":"GET","short_description":"List Matching Leads records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 |
|---|---|
| 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"number","full_name":"number","description":"\nFilter for leads matching this callerid.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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 if a lead has a potential buyer available that matches the lead's filters.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads/show_by_caller_number","name":"show_by_caller_number","apis":[{"api_url":"/api/v1/leads/:lead_token/:caller_number/by_caller_number","http_method":"GET","short_description":"Get a lead by lead token and caller number.","deprecated":null}],"formats":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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"schedule_start","full_name":"schedule_start","description":"\nTranslation missing: en.api.leads.schedule_start
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"schedule_stop","full_name":"schedule_stop","description":"\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":[]},{"name":"move_to_another_schedule_id","full_name":"move_to_another_schedule_id","description":"\nMove 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":[]},{"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":[]},{"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}}”
Translation missing: en.api.leads.category
\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 |
Translation missing: en.api.leads.category
\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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 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":[]}],"returns":[],"examples":["\ncurl -X PUT -d '' trackdrive.com/api/v1/leads/17193132645/caller_opt_out?lead_token=yourtoken\n\n# GET requests are supported\ncurl trackdrive.com/api/v1/leads/17193132645/caller_opt_out?lead_token=yourtoken"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/caller_remove","name":"caller_remove","apis":[{"api_url":"/api/v1/leads/:caller_id/caller_remove","http_method":"POST","short_description":"Remove a single lead from a Schedule or Offer. This will prevent ANY additional actions being taken on behalf of the lead.","deprecated":null}],"formats":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":[]}],"returns":[],"examples":["\ncurl -X POST trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken\ncurl -X DELETE trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken\n\n# GET requests are supported\ncurl trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/leads_external/caller_move_to_end_of_schedule","name":"caller_move_to_end_of_schedule","apis":[{"api_url":"/api/v1/leads/:caller_id/caller_move_to_end_of_schedule","http_method":"PUT","short_description":"Move a lead to the end of it's schedule.","deprecated":null}],"formats":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":[]}],"returns":[],"examples":["\ncurl -X POST -d '' trackdrive.com/api/v1/leads/17193132645/caller_move_to_end_of_schedule?lead_token=yourtoken"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"leads_next_actions":{"doc_url":"/api/docs/1.0/leads_next_actions","id":"leads_next_actions","api_url":"/api","name":"Leads: Scheduled Leads Queue","short_description":"Lists leads that are waiting before running their next schedule action.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/leads_next_actions/index","name":"index","apis":[{"api_url":"/api/v1/leads_next_actions","http_method":"GET","short_description":"List Scheduled Leads records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/create","name":"create","apis":[{"api_url":"/api/v1/map_contact_field_groups","http_method":"POST","short_description":"Create Contact Field Mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/show","name":"show","apis":[{"api_url":"/api/v1/map_contact_field_groups/:id","http_method":"GET","short_description":"Get Contact Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/update","name":"update","apis":[{"api_url":"/api/v1/map_contact_field_groups/:id","http_method":"PUT","short_description":"Update Contact Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/map_contact_field_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/map_contact_field_groups/:id","http_method":"DELETE","short_description":"Destroy Contact Field Mapping by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"map_contact_field_values":{"doc_url":"/api/docs/1.0/map_contact_field_values","id":"map_contact_field_values","api_url":"/api","name":"Field Value Mapping","short_description":"API resource for managing Field Value Mapping.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/map_contact_field_values/index","name":"index","apis":[{"api_url":"/api/v1/map_contact_field_values","http_method":"GET","short_description":"List Field Value Mapping records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\nRing 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":[]},{"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":[]},{"name":"status","full_name":"status","description":"\nStatus
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\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":[]},{"name":"headers","full_name":"headers","description":"\nHeaders
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"error_message","full_name":"error_message","description":"\nError Message
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_count","full_name":"import_count","description":"\nImport Count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"total_count","full_name":"total_count","description":"\nTotal Count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"started_at","full_name":"started_at","description":"\nStarted At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stopped_at","full_name":"stopped_at","description":"\nStopped At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/create","name":"create","apis":[{"api_url":"/api/v1/number_modifications","http_method":"POST","short_description":"Create Number Modification.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\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":[]},{"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":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\nRing 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":[]},{"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":[]},{"name":"status","full_name":"status","description":"\nStatus
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\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":[]},{"name":"headers","full_name":"headers","description":"\nHeaders
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"error_message","full_name":"error_message","description":"\nError Message
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_count","full_name":"import_count","description":"\nImport Count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"total_count","full_name":"total_count","description":"\nTotal Count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"started_at","full_name":"started_at","description":"\nStarted At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stopped_at","full_name":"stopped_at","description":"\nStopped At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/show","name":"show","apis":[{"api_url":"/api/v1/number_modifications/:id","http_method":"GET","short_description":"Get Number Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/update","name":"update","apis":[{"api_url":"/api/v1/number_modifications/:id","http_method":"PUT","short_description":"Update Number Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paused","full_name":"paused","description":"\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":[]},{"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":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\nRing 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":[]},{"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":[]},{"name":"status","full_name":"status","description":"\nStatus
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_file","full_name":"import_file","description":"\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":[]},{"name":"headers","full_name":"headers","description":"\nHeaders
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"error_message","full_name":"error_message","description":"\nError Message
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"import_count","full_name":"import_count","description":"\nImport Count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"total_count","full_name":"total_count","description":"\nTotal Count
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"started_at","full_name":"started_at","description":"\nStarted At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"stopped_at","full_name":"stopped_at","description":"\nStopped At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_modifications/destroy","name":"destroy","apis":[{"api_url":"/api/v1/number_modifications/:id","http_method":"DELETE","short_description":"Destroy Number Modification by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"number_order_prefixes":{"doc_url":"/api/docs/1.0/number_order_prefixes","id":"number_order_prefixes","api_url":"/api","name":"Number Order Prefix","short_description":"API resource for managing Number Order Prefix.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/number_order_prefixes/index","name":"index","apis":[{"api_url":"/api/v1/number_order_prefixes","http_method":"GET","short_description":"List Number Order Prefix records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/create","name":"create","apis":[{"api_url":"/api/v1/number_order_prefixes","http_method":"POST","short_description":"Create Number Order Prefix.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number_order_id","full_name":"number_order_id","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/show","name":"show","apis":[{"api_url":"/api/v1/number_order_prefixes/:id","http_method":"GET","short_description":"Get Number Order Prefix by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/update","name":"update","apis":[{"api_url":"/api/v1/number_order_prefixes/:id","http_method":"PUT","short_description":"Update Number Order Prefix by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number_order_id","full_name":"number_order_id","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_order_prefixes/destroy","name":"destroy","apis":[{"api_url":"/api/v1/number_order_prefixes/:id","http_method":"DELETE","short_description":"Destroy Number Order Prefix by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"number_orders":{"doc_url":"/api/docs/1.0/number_orders","id":"number_orders","api_url":"/api","name":"Number Order","short_description":"API resource for managing Number Orders.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/number_orders/index","name":"index","apis":[{"api_url":"/api/v1/number_orders","http_method":"GET","short_description":"List Number Orders.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Translation missing: en.api.number_orders.offer_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\nTranslation missing: en.api.number_orders.ring_pool_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\nTranslation missing: en.api.number_orders.traffic_source_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\nTranslation missing: en.api.number_orders.schedule_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":[]},{"name":"name","full_name":"name","description":"\nTranslation missing: en.api.number_orders.name
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nTranslation missing: en.api.number_orders.description
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\nTranslation missing: en.api.number_orders.provider_configuration_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/create","name":"create","apis":[{"api_url":"/api/v1/number_orders","http_method":"POST","short_description":"Create Number Order.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\nTranslation missing: en.api.number_orders.offer_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\nTranslation missing: en.api.number_orders.ring_pool_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\nTranslation missing: en.api.number_orders.traffic_source_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\nTranslation missing: en.api.number_orders.schedule_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":[]},{"name":"name","full_name":"name","description":"\nTranslation missing: en.api.number_orders.name
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nTranslation missing: en.api.number_orders.description
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\nTranslation missing: en.api.number_orders.provider_configuration_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/show","name":"show","apis":[{"api_url":"/api/v1/number_orders/:id","http_method":"GET","short_description":"Get Number Order by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/update","name":"update","apis":[{"api_url":"/api/v1/number_orders/:id","http_method":"PUT","short_description":"Update Number Order by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\nTranslation missing: en.api.number_orders.offer_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ring_pool_id","full_name":"ring_pool_id","description":"\nTranslation missing: en.api.number_orders.ring_pool_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Number Pool}[/api/docs/1.0/ring_pools/index.html]. Refer to: {/api/docs/1.0/ring_pools}[/api/docs/1.0/ring_pools/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\nTranslation missing: en.api.number_orders.traffic_source_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Traffic Source}[/api/docs/1.0/traffic_sources/index.html]. Refer to: {/api/docs/1.0/traffic_sources}[/api/docs/1.0/traffic_sources/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_id","full_name":"schedule_id","description":"\nTranslation missing: en.api.number_orders.schedule_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":[]},{"name":"name","full_name":"name","description":"\nTranslation missing: en.api.number_orders.name
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nTranslation missing: en.api.number_orders.description
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_configuration_id","full_name":"provider_configuration_id","description":"\nTranslation missing: en.api.number_orders.provider_configuration_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Provider}[/api/docs/1.0/provider_configurations/index.html]. Refer to: {/api/docs/1.0/provider_configurations}[/api/docs/1.0/provider_configurations/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/number_orders/destroy","name":"destroy","apis":[{"api_url":"/api/v1/number_orders/:id","http_method":"DELETE","short_description":"Destroy Number Order by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"number_ports":{"doc_url":"/api/docs/1.0/number_ports","id":"number_ports","api_url":"/api","name":"Translation missing: en.api.number_ports.resource.name","short_description":"Translation missing: en.api.number_ports.resource.short","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/number_ports/index","name":"index","apis":[{"api_url":"/api/v1/number_ports","http_method":"GET","short_description":"Translation missing: en.api.number_ports.index","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"name":"client_id","full_name":"client_id","description":"\nClient
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_secret","full_name":"client_secret","description":"\nClient Secret
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\nWebhook Remote Url
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\nWebhook Remote Method
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\nWebhook Remote Body
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\nWebhook Remote Headers
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\nWebhook Read Timeout
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nWebhook Response Success Codes
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token_path","full_name":"access_token_path","description":"\nAccess Token Path
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token","full_name":"access_token","description":"\nAccess Token
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_in","full_name":"expires_in","description":"\nExpires In
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"expires_at","description":"\nExpires At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fetched_at","full_name":"fetched_at","description":"\nFetched At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/create","name":"create","apis":[{"api_url":"/api/v1/oauth_connections","http_method":"POST","short_description":"Create Oauth Connection.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_id","full_name":"client_id","description":"\nClient
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_secret","full_name":"client_secret","description":"\nClient Secret
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\nWebhook Remote Url
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\nWebhook Remote Method
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\nWebhook Remote Body
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\nWebhook Remote Headers
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\nWebhook Read Timeout
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nWebhook Response Success Codes
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token_path","full_name":"access_token_path","description":"\nAccess Token Path
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token","full_name":"access_token","description":"\nAccess Token
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_in","full_name":"expires_in","description":"\nExpires In
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"expires_at","description":"\nExpires At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fetched_at","full_name":"fetched_at","description":"\nFetched At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/show","name":"show","apis":[{"api_url":"/api/v1/oauth_connections/:id","http_method":"GET","short_description":"Get Oauth Connection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/update","name":"update","apis":[{"api_url":"/api/v1/oauth_connections/:id","http_method":"PUT","short_description":"Update Oauth Connection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_id","full_name":"client_id","description":"\nClient
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_secret","full_name":"client_secret","description":"\nClient Secret
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_url","full_name":"webhook_remote_url","description":"\nWebhook Remote Url
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_method","full_name":"webhook_remote_method","description":"\nWebhook Remote Method
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_body","full_name":"webhook_remote_body","description":"\nWebhook Remote Body
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_remote_headers","full_name":"webhook_remote_headers","description":"\nWebhook Remote Headers
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_read_timeout","full_name":"webhook_read_timeout","description":"\nWebhook Read Timeout
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nWebhook Response Success Codes
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token_path","full_name":"access_token_path","description":"\nAccess Token Path
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"access_token","full_name":"access_token","description":"\nAccess Token
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_in","full_name":"expires_in","description":"\nExpires In
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"expires_at","description":"\nExpires At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fetched_at","full_name":"fetched_at","description":"\nFetched At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/oauth_connections/destroy","name":"destroy","apis":[{"api_url":"/api/v1/oauth_connections/:id","http_method":"DELETE","short_description":"Destroy Oauth Connection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"offer_amd_flows":{"doc_url":"/api/docs/1.0/offer_amd_flows","id":"offer_amd_flows","api_url":"/api","name":"Offers: AMD Flows","short_description":"API resource for managing AMD Flows.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/offer_amd_flows/index","name":"index","apis":[{"api_url":"/api/v1/offer_amd_flows","http_method":"GET","short_description":"List AMD Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Translation missing: en.api.offer_amd_flows.offer_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nTranslation missing: en.api.offer_amd_flows.description
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\nTranslation missing: en.api.offer_amd_flows.record_token_filter_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.offer_amd_flows.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\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":[]},{"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":[]},{"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":[]}],"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":"\nTranslation missing: en.api.offer_amd_flows.offer_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nTranslation missing: en.api.offer_amd_flows.description
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\nTranslation missing: en.api.offer_amd_flows.record_token_filter_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.offer_amd_flows.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\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":[]},{"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":[]},{"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":[]}],"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":"\nTranslation missing: en.api.offer_amd_flows.offer_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nTranslation missing: en.api.offer_amd_flows.description
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_id","full_name":"record_token_filter_id","description":"\nTranslation missing: en.api.offer_amd_flows.record_token_filter_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filters}[/api/docs/1.0/record_token_filters/index.html]. Refer to: {/api/docs/1.0/record_token_filters}[/api/docs/1.0/record_token_filters/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"token_value_ids","full_name":"token_value_ids","description":"\nTranslation missing: en.api.offer_amd_flows.token_value_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ai_classification_matches","full_name":"ai_classification_matches","description":"\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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_amd_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/offer_amd_flows/:id","http_method":"DELETE","short_description":"Destroy AMD Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"offer_conversions":{"doc_url":"/api/docs/1.0/offer_conversions","id":"offer_conversions","api_url":"/api","name":"Traffic Sources: Conversions","short_description":"The set of Traffic Source Conversions in your Trackdrive Account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/offer_conversions/index","name":"index","apis":[{"api_url":"/api/v1/offer_conversions","http_method":"GET","short_description":"List the Traffic Source Conversions in your Trackdrive Account.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\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 conversion will be added 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":[]},{"name":"business_range_id","full_name":"business_range_id","description":"\nThe conversion will be added to these business hours. Leave this blank to automatically assign the currently open business hours.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days & Hours}[/api/docs/1.0//index.html]. Refer to: {/api/docs/1.0/}[/api/docs/1.0//index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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. |
How should the payout be calculated?
buyer_conversion_percent: Calculate the payout as a percentage of the revenue paid to the buyer.
usd: Pay the Traffic Source this amount.
usd, buyer_conversion_percent.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payout","full_name":"payout","description":"\nThe Traffic Source will be paid this amount when payout_type is set to usd
Calculate the payout as a percentage of the revenue paid to the buyer when payout_type is set to buyer_conversion_percent. A value of 60 would pay 60% of the revenue to the Traffic Source. If the buyer revenue is $15 and the percent is 60, the calculated payout would be $9
The number of seconds after the buyer answers the call before the traffic source gets paid. 0 seconds means the call will convert for the traffic source even if a buyer doesn't answer.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\nThe period of time that must elapse before a traffic source will be paid again when transferring the same CallerID.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nThis name that will appear in your call logs when the call converts.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"offer_id","full_name":"offer_id","description":"\nThe conversion will be added 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":[]},{"name":"business_range_id","full_name":"business_range_id","description":"\nThe conversion will be added to these business hours. Leave this blank to automatically assign the currently open business hours.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Business Days & Hours}[/api/docs/1.0//index.html]. Refer to: {/api/docs/1.0/}[/api/docs/1.0//index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\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":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\nThe order in which Traffic Source Conversions will be checked for a matching conversion. Values are sorted in ascending order; smaller values are checked first.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"payout\": 10, \"duration\": 60, duplicate_timeframe: 3600, name: \"Pay $10 after 1 minute, deduped by 1 hour.\", offer_id: 10001234}' https://[your-subdomain].trackdrive.com/api/v1/offer_conversions"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/update","name":"update","apis":[{"api_url":"/api/v1/offer_conversions/:id","http_method":"PUT","short_description":"Update a Traffic Source Conversion by ID.","deprecated":null}],"formats":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. |
How should the payout be calculated?
buyer_conversion_percent: Calculate the payout as a percentage of the revenue paid to the buyer.
usd: Pay the Traffic Source this amount.
usd, buyer_conversion_percent.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payout","full_name":"payout","description":"\nThe Traffic Source will be paid this amount when payout_type is set to usd
Calculate the payout as a percentage of the revenue paid to the buyer when payout_type is set to buyer_conversion_percent. A value of 60 would pay 60% of the revenue to the Traffic Source. If the buyer revenue is $15 and the percent is 60, the calculated payout would be $9
The number of seconds after the buyer answers the call before the traffic source gets paid. 0 seconds means the call will convert for the traffic source even if a buyer doesn't answer.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"duplicate_timeframe","full_name":"duplicate_timeframe","description":"\nThe period of time that must elapse before a traffic source will be paid again when transferring the same CallerID.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nThis name that will appear in your call logs when the call converts.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\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":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\nThe order in which Traffic Source Conversions will be checked for a matching conversion. Values are sorted in ascending order; smaller values are checked first.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"payout\": 9, \"duration\": 120}' https://[your-subdomain].trackdrive.com/api/v1/offer_conversions/1008923"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offer_conversions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/offer_conversions/:id","http_method":"DELETE","short_description":"Delete a Traffic Source Conversion by ID.","deprecated":null}],"formats":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. |
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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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. |
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. |
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. |
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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":"PUT","short_description":"Update Offer by id.","deprecated":null},{"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. |
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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"outgoing_webhook_urls":{"doc_url":"/api/docs/1.0/outgoing_webhook_urls","id":"outgoing_webhook_urls","api_url":"/api","name":"Outgoing Webhooks: URLs","short_description":"Configure the URLs that fire when an Outgoing Webhook is triggered.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/index","name":"index","apis":[{"api_url":"/api/v1/outgoing_webhook_urls","http_method":"GET","short_description":"List webhook urls","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\nFilter 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/create","name":"create","apis":[{"api_url":"/api/v1/outgoing_webhook_urls","http_method":"POST","short_description":"Create a webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/show","name":"show","apis":[{"api_url":"/api/v1/outgoing_webhook_urls/:id","http_method":"GET","short_description":"Show the details of a webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/update","name":"update","apis":[{"api_url":"/api/v1/outgoing_webhook_urls/:id","http_method":"PUT","short_description":"Update a webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhook_urls/destroy","name":"destroy","apis":[{"api_url":"/api/v1/outgoing_webhook_urls/:id","http_method":"DELETE","short_description":"Delete a webhook url","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"outgoing_webhooks":{"doc_url":"/api/docs/1.0/outgoing_webhooks","id":"outgoing_webhooks","api_url":"/api","name":"Outgoing Webhooks","short_description":"Webhooks (also known as Postbacks) fire when a triggers occurs, such as a buyer being dialed or a call ending.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/outgoing_webhooks/index","name":"index","apis":[{"api_url":"/api/v1/outgoing_webhooks","http_method":"GET","short_description":"List webhooks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\nTranslation missing: en.api.outgoing_webhooks.buyer_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\nTranslation missing: en.api.outgoing_webhooks.buyer_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_id","full_name":"call_router_id","description":"\nTranslation missing: en.api.outgoing_webhooks.call_router_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Flow}[/api/docs/1.0/call_routers/index.html]. Refer to: {/api/docs/1.0/call_routers}[/api/docs/1.0/call_routers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhooks/create","name":"create","apis":[{"api_url":"/api/v1/outgoing_webhooks","http_method":"POST","short_description":"Create a webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"global_company_id","full_name":"global_company_id","description":"\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":[]},{"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":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\nTranslation missing: en.api.outgoing_webhooks.buyer_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_id","full_name":"call_router_id","description":"\nTranslation missing: en.api.outgoing_webhooks.call_router_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Flow}[/api/docs/1.0/call_routers/index.html]. Refer to: {/api/docs/1.0/call_routers}[/api/docs/1.0/call_routers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"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":[]},{"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":[]},{"name":"buyer_id","full_name":"buyer_id","description":"\nTranslation missing: en.api.outgoing_webhooks.buyer_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_router_id","full_name":"call_router_id","description":"\nTranslation missing: en.api.outgoing_webhooks.call_router_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call Flow}[/api/docs/1.0/call_routers/index.html]. Refer to: {/api/docs/1.0/call_routers}[/api/docs/1.0/call_routers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"schedule_action_id","full_name":"schedule_action_id","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/outgoing_webhooks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/outgoing_webhooks/:id","http_method":"DELETE","short_description":"Delete a webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"pgbouncer_databases":{"doc_url":"/api/docs/1.0/pgbouncer_databases","id":"pgbouncer_databases","api_url":"/api","name":"PgBouncer Database","short_description":"API resource for managing PgBouncer Database.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/pgbouncer_databases/index","name":"index","apis":[{"api_url":"/api/v1/pgbouncer_databases","http_method":"GET","short_description":"List PgBouncer Database records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 |
|---|---|
| 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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 |
|---|---|
| number | Default response format. |
| number_grid | Modern response format that returns various foreign keys for use with other API endpoints. |
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":[]},{"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":[]},{"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":[]},{"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:AR, AT, AU, BE, BG, BH, BR, CA, CH, CL, CN, CO, CY, CZ, DE, DK, DO, EE, ES, FI, FR, GB, GE, GR, HK, HR, HU, ID, IE, IL, IT, JP, KR, LT, LU, LV, MT, MX, MY, NL, NO, NZ, PA, PE, PH, PK, PL, PR, PT, RO, RU, SE, SG, SI, SK, SV, TR, US, ZA.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{provider_configuration_id: 150, offer_id: 100, toll_free: true, country: 'US'}' https://[your-subdomain].trackdrive.com/api/v1/phone_numbers.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/phone_numbers/show","name":"show","apis":[{"api_url":"/api/v1/phone_numbers/:id","http_method":"GET","short_description":"Show the details of phone number","deprecated":null}],"formats":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"
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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"traffic_source_id\":\"1002592\"}' https://[your-subdomain].trackdrive.com/api/v1/phone_numbers/:id"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/phone_numbers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/phone_numbers/:id","http_method":"DELETE","short_description":"Unrent a phone number.","deprecated":null}],"formats":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 |
|---|---|
| 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]}],"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":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_default","full_name":"is_default","description":"\nIs this provider the default for new number purchases.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"is_default\":\"true\", \"name\": \"New Name\"}' https://[your-subdomain].trackdrive.com/api/v1/provider_configurations/:id"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"rates":{"doc_url":"/api/docs/1.0/rates","id":"rates","api_url":"/api","name":"Rates","short_description":"TrackDrive Rates.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/rates/show_by_number","name":"show_by_number","apis":[{"api_url":"/api/v1/rates/:number","http_method":"GET","short_description":"Get the rate to call a telephone number.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"number","full_name":"number","description":"\nA telephone number like 17191231234
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"record_token_filters":{"doc_url":"/api/docs/1.0/record_token_filters","id":"record_token_filters","api_url":"/api","name":"Filter Group","short_description":"API resource for managing Filter Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/record_token_filters/index","name":"index","apis":[{"api_url":"/api/v1/record_token_filters","http_method":"GET","short_description":"List Filter Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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 record that owns this record.
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_filters/show","name":"show","apis":[{"api_url":"/api/v1/record_token_filters/:id","http_method":"GET","short_description":"Get Filter Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/record_token_filters/update","name":"update","apis":[{"api_url":"/api/v1/record_token_filters/:id","http_method":"PUT","short_description":"Update Filter Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"toggle_equals_buyer_ids","full_name":"toggle_equals_buyer_ids","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_buyer_ids
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_traffic_source_ids","full_name":"toggle_equals_traffic_source_ids","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_traffic_source_ids
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_buyer_group_ids","full_name":"toggle_equals_buyer_group_ids","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_buyer_group_ids
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_offer_ids","full_name":"toggle_equals_offer_ids","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_offer_ids
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_number_ids","full_name":"toggle_equals_number_ids","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_number_ids
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_schedule_ids","full_name":"toggle_equals_schedule_ids","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_schedule_ids
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_lead_import_ids","full_name":"toggle_equals_lead_import_ids","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_lead_import_ids
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_zip_code_list_ids","full_name":"toggle_equals_zip_code_list_ids","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_zip_code_list_ids
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_area_codes","full_name":"toggle_equals_area_codes","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_area_codes
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_countries","full_name":"toggle_equals_countries","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_countries
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"toggle_equals_states","full_name":"toggle_equals_states","description":"\nTranslation missing: en.api.record_token_filters.toggle_equals_states
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"record_token_params":{"doc_url":"/api/docs/1.0/record_token_params","id":"record_token_params","api_url":"/api","name":"Filter","short_description":"API resource for managing Filter.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/record_token_params/index","name":"index","apis":[{"api_url":"/api/v1/record_token_params","http_method":"GET","short_description":"List Filter records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Translation missing: en.api.response_parsers.outgoing_webhook_url_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\nBuyer Conversion
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nAcceptable HTTP Status Codes
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nToken Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\nProvide the path to extract a value. EG: lead.id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/create","name":"create","apis":[{"api_url":"/api/v1/response_parsers","http_method":"POST","short_description":"Create Response Parser.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_url_id","full_name":"outgoing_webhook_url_id","description":"\nTranslation missing: en.api.response_parsers.outgoing_webhook_url_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\nBuyer Conversion
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nAcceptable HTTP Status Codes
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nToken Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\nProvide the path to extract a value. EG: lead.id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/show","name":"show","apis":[{"api_url":"/api/v1/response_parsers/:id","http_method":"GET","short_description":"Get Response Parser by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/update","name":"update","apis":[{"api_url":"/api/v1/response_parsers/:id","http_method":"PUT","short_description":"Update Response Parser by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_url_id","full_name":"outgoing_webhook_url_id","description":"\nTranslation missing: en.api.response_parsers.outgoing_webhook_url_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Outgoing Webhook URL}[/api/docs/1.0/outgoing_webhook_urls/index.html]. Refer to: {/api/docs/1.0/outgoing_webhook_urls}[/api/docs/1.0/outgoing_webhook_urls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\nBuyer Conversion
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"webhook_response_success_codes","full_name":"webhook_response_success_codes","description":"\nAcceptable HTTP Status Codes
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"key","description":"\nToken Key
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_path","full_name":"value_path","description":"\nProvide the path to extract a value. EG: lead.id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/response_parsers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/response_parsers/:id","http_method":"DELETE","short_description":"Destroy Response Parser by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ring_pools":{"doc_url":"/api/docs/1.0/ring_pools","id":"ring_pools","api_url":"/api","name":"Phone Number Pools","short_description":"API resource for managing Phone Number Pool.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/ring_pools/index","name":"index","apis":[{"api_url":"/api/v1/ring_pools","http_method":"GET","short_description":"List Phone Number Pools.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/ring_pools/destroy","name":"destroy","apis":[{"api_url":"/api/v1/ring_pools/:id","http_method":"DELETE","short_description":"Destroy Phone Number Pool by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_action_groups":{"doc_url":"/api/docs/1.0/schedule_action_groups","id":"schedule_action_groups","api_url":"/api","name":"Action Group","short_description":"API resource for managing Action Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_action_groups/index","name":"index","apis":[{"api_url":"/api/v1/schedule_action_groups","http_method":"GET","short_description":"List Action Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":"\nTranslation missing: en.api.schedule_actions.schedule_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":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\nTranslation missing: en.api.schedule_actions.owner_relations
\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":[]},{"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":[]}],"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":"\nTranslation missing: en.api.schedule_actions.schedule_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":[]},{"name":"owner_relation","full_name":"owner_relation","description":"\nTranslation missing: en.api.schedule_actions.owner_relation
\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":[]},{"name":"action_type","full_name":"action_type","description":"\nTranslation missing: en.api.schedule_actions.action_type
\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":[]},{"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":[]},{"name":"token_value_map_group_ids","full_name":"token_value_map_group_ids","description":"\nTranslation missing: en.api.schedule_actions.token_value_map_group_ids
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Filter Mapping Group}[/api/docs/1.0/token_value_map_groups/index.html]. Refer to: {/api/docs/1.0/token_value_map_groups}[/api/docs/1.0/token_value_map_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_actions/show","name":"show","apis":[{"api_url":"/api/v1/schedule_actions/:id","http_method":"GET","short_description":"Get details about a schedule action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_actions/update","name":"update","apis":[{"api_url":"/api/v1/schedule_actions/:id","http_method":"PUT","short_description":"Update a schedule action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\nTranslation missing: en.api.schedule_actions.schedule_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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_actions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_actions/:id","http_method":"DELETE","short_description":"Destroy a schedule action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_agents":{"doc_url":"/api/docs/1.0/schedule_agents","id":"schedule_agents","api_url":"/api","name":"Agent Wizard","short_description":"API resource for managing Agents created via the Agent Wizard.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_agents/index","name":"index","apis":[{"api_url":"/api/v1/schedule_agents","http_method":"GET","short_description":"List Agent Wizard records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"name":"is_internal","full_name":"is_internal","description":"\nInternal agents only have access to your company and have a predefined password.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"buyer_type","full_name":"buyer_type","description":"\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":[]},{"name":"email","full_name":"email","description":"\nUsername
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\nLast Name
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"company_name","full_name":"company_name","description":"\nCompany Name
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone_number","full_name":"phone_number","description":"\nPhone Number
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_state","full_name":"address_state","description":"\nAddress State
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_city","full_name":"address_city","description":"\nAddress City
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_country","full_name":"address_country","description":"\nAddress Country
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_zip","full_name":"address_zip","description":"\nAddress Zip
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_line1","full_name":"address_line1","description":"\nAddress Line1
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address_line2","full_name":"address_line2","description":"\nAddress Line2
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_center_id","full_name":"call_center_id","description":"\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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_agents/show","name":"show","apis":[{"api_url":"/api/v1/schedule_agents/:id","http_method":"GET","short_description":"Get Agent Wizard record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_agents/update","name":"update","apis":[{"api_url":"/api/v1/schedule_agents/:id","http_method":"PUT","short_description":"Update Agent Wizard record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_agents/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_agents/:id","http_method":"DELETE","short_description":"Destroy Agent Wizard record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_distributions":{"doc_url":"/api/docs/1.0/schedule_distributions","id":"schedule_distributions","api_url":"/api","name":"Schedules: Lead Distribution","short_description":"Route incoming leads to different schedules based on predefined filters. Configure filters using attributes such as geographic location, interest, lead score, or custom fields. When a new lead is received, the API evaluates these filters to automatically assign the lead to the appropriate schedule. This feature streamlines the lead distribution process, enabling quicker response times and more targeted engagement.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_distributions/index","name":"index","apis":[{"api_url":"/api/v1/schedule_distributions","http_method":"GET","short_description":"List Distribution records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\nTranslation missing: en.api.schedule_distributions.filter_group_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/create","name":"create","apis":[{"api_url":"/api/v1/schedule_distributions","http_method":"POST","short_description":"Create Distribution.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\nTranslation missing: en.api.schedule_distributions.filter_group_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/show","name":"show","apis":[{"api_url":"/api/v1/schedule_distributions/:id","http_method":"GET","short_description":"Get Distribution by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/update","name":"update","apis":[{"api_url":"/api/v1/schedule_distributions/:id","http_method":"PUT","short_description":"Update Distribution by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"name":"filter_group_id","full_name":"filter_group_id","description":"\nTranslation missing: en.api.schedule_distributions.filter_group_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Filter Group}[/api/docs/1.0/filter_groups/index.html]. Refer to: {/api/docs/1.0/filter_groups}[/api/docs/1.0/filter_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_distributions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_distributions/:id","http_method":"DELETE","short_description":"Destroy Distribution by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedule_triggers":{"doc_url":"/api/docs/1.0/schedule_triggers","id":"schedule_triggers","api_url":"/api","name":"Schedules: Triggers","short_description":"The End Of Schedule Triggers in your account. Leads will be moved to \"End Of Schedule Actions\" when any of the triggers below match.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedule_triggers/index","name":"index","apis":[{"api_url":"/api/v1/schedule_triggers","http_method":"GET","short_description":"Search for Schedule Triggers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\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":[]},{"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":[]}],"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expire_timestamp_name","full_name":"expire_timestamp_name","description":"\nTranslation missing: en.api.schedule_triggers.expire_timestamp_name
\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_triggers/show","name":"show","apis":[{"api_url":"/api/v1/schedule_triggers/:id","http_method":"GET","short_description":"Returns a Schedule Trigger by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_triggers/update","name":"update","apis":[{"api_url":"/api/v1/schedule_triggers/:id","http_method":"PUT","short_description":"Updates a Schedule Trigger by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"schedule_id","full_name":"schedule_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedule_triggers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedule_triggers/:id","http_method":"DELETE","short_description":"Delete a Schedule Trigger by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"scheduled_callbacks":{"doc_url":"/api/docs/1.0/scheduled_callbacks","id":"scheduled_callbacks","api_url":"/api","name":"Calls: Scheduled Callbacks","short_description":"The Scheduled Callbacks in your account. Calls will be placed to leads when the callback matches.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/scheduled_callbacks/index","name":"index","apis":[{"api_url":"/api/v1/scheduled_callbacks","http_method":"GET","short_description":"List scheduled callbacks.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/scheduled_callbacks/new","name":"new","apis":[{"api_url":"/api/v1/scheduled_callbacks/new","http_method":"GET","short_description":"Returns a new Scheduled Callback","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_id","full_name":"call_id","description":"\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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -X POST \"trackdrive.com/api/v1/scheduled_callbacks?place_call_at=2025-07-20+08%3A40&place_call_time_zone=Eastern+Time+%28US+%26+Canada%29&schedule_id=12345678&to=%2B16053334444\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/scheduled_callbacks/show","name":"show","apis":[{"api_url":"/api/v1/scheduled_callbacks/:id","http_method":"GET","short_description":"Returns a Scheduled Callback by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"call_id","full_name":"call_id","description":"\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":[]},{"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":[]}],"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":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/scheduled_callbacks/destroy","name":"destroy","apis":[{"api_url":"/api/v1/scheduled_callbacks/:id","http_method":"DELETE","short_description":"Delete a Scheduled Callback by ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"schedules":{"doc_url":"/api/docs/1.0/schedules","id":"schedules","api_url":"/api","name":"Schedules","short_description":"The schedules in your Trackdrive account. Automate placing calls, SMS, Emails, and more to leads.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/schedules/index","name":"index","apis":[{"api_url":"/api/v1/schedules","http_method":"GET","short_description":"List schedules.","deprecated":null}],"formats":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 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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/schedules?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/new","name":"new","apis":[{"api_url":"/api/v1/schedules/new","http_method":"GET","short_description":"Build a schedule with default attributes.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\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. |
Refer 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":[]},{"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. |
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. |
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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/schedules/destroy","name":"destroy","apis":[{"api_url":"/api/v1/schedules/:id","http_method":"DELETE","short_description":"Destroy a schedule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\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. |
td_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 with td_secure_token and td_uuid passed in a call's SIP headers.","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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"name":"data","full_name":"data","description":"\nUpdate the call with this data. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'}
td_secure_token and td_uuid passed in a call's SIP headers.","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":[]},{"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":[]}],"returns":[],"examples":["curl -i -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/secure/11111111035c9a8287c2e413a03fb32051f620e0/calls/77777777-dbe3-49ee-b28f-115ec80dcef9\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/secure_calls/data","name":"data","apis":[{"api_url":"/api/v1/secure/:secure_token/calls/:uuid/data","http_method":"GET","short_description":"Returns UUID and data for the call.","deprecated":null}],"formats":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":[]},{"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":[]}],"returns":[],"examples":["curl -i -X GET \"https://[your-subdomain].trackdrive.com/api/v1/secure/11111111035c9a8287c2e413a03fb32051f620e0/calls/77777777-dbe3-49ee-b28f-115ec80dcef9/data\""],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sip_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":"API resource for managing SIP Header Parsing.","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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":"API resource for managing SIP Key.","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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":"API resource for managing Sip Header.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sip_headers/index","name":"index","apis":[{"api_url":"/api/v1/sip_headers","http_method":"GET","short_description":"List Sip Header records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sip_headers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sip_headers/:id","http_method":"DELETE","short_description":"Destroy Sip Header by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sms_ai_flows":{"doc_url":"/api/docs/1.0/sms_ai_flows","id":"sms_ai_flows","api_url":"/api","name":"Offers: SMS AI Flows","short_description":"API resource for managing how Incoming SMS will be handled.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sms_ai_flows/index","name":"index","apis":[{"api_url":"/api/v1/sms_ai_flows","http_method":"GET","short_description":"List SMS AI Rules records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Sortable Order
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\nFilter By Traffic 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":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/create","name":"create","apis":[{"api_url":"/api/v1/sms_ai_flows","http_method":"POST","short_description":"Create SMS AI Rules.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"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":[]},{"name":"external_campaign_id","full_name":"external_campaign_id","description":"\nExternal Campaign
\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\nSortable Order
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\nFilter By Traffic 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":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/show","name":"show","apis":[{"api_url":"/api/v1/sms_ai_flows/:id","http_method":"GET","short_description":"Get SMS AI Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/update","name":"update","apis":[{"api_url":"/api/v1/sms_ai_flows/:id","http_method":"PUT","short_description":"Update SMS AI Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_campaign_id","full_name":"external_campaign_id","description":"\nExternal Campaign
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\nSortable Order
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"traffic_source_id","full_name":"traffic_source_id","description":"\nFilter By Traffic 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":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sms_ai_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sms_ai_flows/:id","http_method":"DELETE","short_description":"Destroy SMS AI Rules by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sound_files":{"doc_url":"/api/docs/1.0/sound_files","id":"sound_files","api_url":"/api","name":"Playlists: Sound Files","short_description":"API resource for managing Sound File.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sound_files/index","name":"index","apis":[{"api_url":"/api/v1/sound_files","http_method":"GET","short_description":"List Sound File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_files/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sound_files/:id","http_method":"DELETE","short_description":"Destroy Sound File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sound_playlists":{"doc_url":"/api/docs/1.0/sound_playlists","id":"sound_playlists","api_url":"/api","name":"Playlists","short_description":"API resource for managing Playlist.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/sound_playlists/index","name":"index","apis":[{"api_url":"/api/v1/sound_playlists","http_method":"GET","short_description":"List Playlist records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/sound_playlists/destroy","name":"destroy","apis":[{"api_url":"/api/v1/sound_playlists/:id","http_method":"DELETE","short_description":"Destroy Playlist by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"standalone_transcriptions":{"doc_url":"/api/docs/1.0/standalone_transcriptions","id":"standalone_transcriptions","api_url":"/api","name":"Standalone Transcription","short_description":"API resource for managing Standalone Transcription.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/standalone_transcriptions/index","name":"index","apis":[{"api_url":"/api/v1/standalone_transcriptions","http_method":"GET","short_description":"List Standalone Transcription records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["# Submit standalone transcriptions as JSON:\ncurl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -X POST \\\n -d '{\"caller_id\":\"+18004506787\",\"file_url\":\"http://example.com/publicly_accessible_file.mp3\",\"postback_url\":\"http://example.com/postback_url_without_authentication\",\"data\":{\"loan_amount\":\"501\",\"custom_token\":\"the_value\"}}' \\\n \"https://[your-subdomain].trackdrive.com/api/v1/standalone_transcriptions\"\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/standalone_transcriptions/show","name":"show","apis":[{"api_url":"/api/v1/standalone_transcriptions/:id","http_method":"GET","short_description":"Get Standalone Transcription by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"caller_id","full_name":"caller_id","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/standalone_transcriptions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/standalone_transcriptions/:id","http_method":"DELETE","short_description":"Destroy Standalone Transcription by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"state_business_hours":{"doc_url":"/api/docs/1.0/state_business_hours","id":"state_business_hours","api_url":"/api","name":"State Call Time","short_description":"API resource for managing State Call Time.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/state_business_hours/index","name":"index","apis":[{"api_url":"/api/v1/state_business_hours","http_method":"GET","short_description":"List State Call Time records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/create","name":"create","apis":[{"api_url":"/api/v1/state_business_hours","http_method":"POST","short_description":"Create State Call Time.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/show","name":"show","apis":[{"api_url":"/api/v1/state_business_hours/:id","http_method":"GET","short_description":"Get State Call Time by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/update","name":"update","apis":[{"api_url":"/api/v1/state_business_hours/:id","http_method":"PUT","short_description":"Update State Call Time by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_business_hours/destroy","name":"destroy","apis":[{"api_url":"/api/v1/state_business_hours/:id","http_method":"DELETE","short_description":"Destroy State Call Time by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"state_call_limits":{"doc_url":"/api/docs/1.0/state_call_limits","id":"state_call_limits","api_url":"/api","name":"State Call Frequency","short_description":"API resource for managing State Call Frequency.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/state_call_limits/index","name":"index","apis":[{"api_url":"/api/v1/state_call_limits","http_method":"GET","short_description":"List State Call Frequency records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/create","name":"create","apis":[{"api_url":"/api/v1/state_call_limits","http_method":"POST","short_description":"Create State Call Frequency.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/show","name":"show","apis":[{"api_url":"/api/v1/state_call_limits/:id","http_method":"GET","short_description":"Get State Call Frequency by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/update","name":"update","apis":[{"api_url":"/api/v1/state_call_limits/:id","http_method":"PUT","short_description":"Update State Call Frequency by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"states","full_name":"states","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_call_limits/destroy","name":"destroy","apis":[{"api_url":"/api/v1/state_call_limits/:id","http_method":"DELETE","short_description":"Destroy State Call Frequency by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"state_holidays":{"doc_url":"/api/docs/1.0/state_holidays","id":"state_holidays","api_url":"/api","name":"State Holiday","short_description":"API resource for managing State Holiday.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/state_holidays/index","name":"index","apis":[{"api_url":"/api/v1/state_holidays","http_method":"GET","short_description":"List State Holiday records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/state_holidays/destroy","name":"destroy","apis":[{"api_url":"/api/v1/state_holidays/:id","http_method":"DELETE","short_description":"Destroy State Holiday by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"state_rule_groups":{"doc_url":"/api/docs/1.0/state_rule_groups","id":"state_rule_groups","api_url":"/api","name":"State Call Rules","short_description":"API resource for managing State Call Rules.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/state_rule_groups/index","name":"index","apis":[{"api_url":"/api/v1/state_rule_groups","http_method":"GET","short_description":"List State Call Rules records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/subscriptions?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/new","name":"new","apis":[{"api_url":"/api/v1/webhook_subscriptions/new","http_method":"GET","short_description":"Build Webhook Subscription with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/subscriptions/create","name":"create","apis":[{"api_url":"/api/v1/subscriptions","http_method":"POST","short_description":"Create a subscription","deprecated":null}],"formats":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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"target_url\": \"https://hooks.zapier.com/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 String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE -d '{\"target_url\": \"https://hooks.zapier.com/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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
Translation missing: en.api.token_matchers.offer_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/create","name":"create","apis":[{"api_url":"/api/v1/token_matchers","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/show","name":"show","apis":[{"api_url":"/api/v1/token_matchers/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/update","name":"update","apis":[{"api_url":"/api/v1/token_matchers/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"token_key","full_name":"token_key","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_matchers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/token_matchers/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"token_value_map_groups":{"doc_url":"/api/docs/1.0/token_value_map_groups","id":"token_value_map_groups","api_url":"/api","name":"Field Mapping Group","short_description":"API resource for managing Field Mapping Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/token_value_map_groups/index","name":"index","apis":[{"api_url":"/api/v1/token_value_map_groups","http_method":"GET","short_description":"List Field Mapping Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/create","name":"create","apis":[{"api_url":"/api/v1/token_value_map_groups","http_method":"POST","short_description":"Create Field Mapping Group.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/show","name":"show","apis":[{"api_url":"/api/v1/token_value_map_groups/:id","http_method":"GET","short_description":"Get Field Mapping Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/update","name":"update","apis":[{"api_url":"/api/v1/token_value_map_groups/:id","http_method":"PUT","short_description":"Update Field Mapping Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\nDescription
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_map_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/token_value_map_groups/:id","http_method":"DELETE","short_description":"Destroy Field Mapping Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"token_value_maps":{"doc_url":"/api/docs/1.0/token_value_maps","id":"token_value_maps","api_url":"/api","name":"Custom Field Mappings","short_description":"Configure data mappings for custom field values. EG: IF interest EQUALS Raccoons THEN send racoons-29838. This is useful for integrating with third-party systems that require you to send internal IDs in Webhook Postbacks.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/token_value_maps/index","name":"index","apis":[{"api_url":"/api/v1/token_value_maps","http_method":"GET","short_description":"List field mappings.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\nFilter for field mappings 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":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\nAssign the record to this Buyer Conversion Criteria.
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\nAssign the record to this Buyer Conversion Criteria.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\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":[]},{"name":"key","full_name":"key","description":"\nTranslation missing: en.api.token_value_maps.key
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\nThe value that will be applied if the key_compare and value_compare match the token's key and value.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\nExpression Formatter
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/create","name":"create","apis":[{"api_url":"/api/v1/token_value_maps","http_method":"POST","short_description":"Create field mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\nAssign the record to this Outgoing Webhook.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\nAssign the record to this Buyer Conversion Criteria.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\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":[]},{"name":"key","full_name":"key","description":"\nTranslation missing: en.api.token_value_maps.key
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\nThe value that will be applied if the key_compare and value_compare match the token's key and value.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\nExpression Formatter
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/show","name":"show","apis":[{"api_url":"/api/v1/token_value_maps/:id","http_method":"GET","short_description":"Show field mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/update","name":"update","apis":[{"api_url":"/api/v1/token_value_maps/:id","http_method":"PUT","short_description":"Update field mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\nAssign the record to this Outgoing Webhook.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\nAssign the record to this Buyer Conversion Criteria.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\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":[]},{"name":"key","full_name":"key","description":"\nTranslation missing: en.api.token_value_maps.key
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\nThe value that will be applied if the key_compare and value_compare match the token's key and value.
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value_formatter","full_name":"value_formatter","description":"\nExpression Formatter
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:string, decimal, integer, time, boolean.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/token_value_maps/destroy","name":"destroy","apis":[{"api_url":"/api/v1/token_value_maps/:id","http_method":"DELETE","short_description":"Delete field mapping.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"token_values":{"doc_url":"/api/docs/1.0/token_values","id":"token_values","api_url":"/api","name":"Tokens: Values","short_description":"The token values in your Trackdrive account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/token_values/index","name":"index","apis":[{"api_url":"/api/v1/token_values","http_method":"GET","short_description":"List your token values.","deprecated":null}],"formats":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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/tokens?page=1&order=created_at\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/show","name":"show","apis":[{"api_url":"/api/v1/tokens/:id","http_method":"GET","short_description":"Get Token by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/tokens/1\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/new","name":"new","apis":[{"api_url":"/api/v1/tokens/new","http_method":"GET","short_description":"Build Token with defaults.","deprecated":null}],"formats":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":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text_color","full_name":"text_color","description":"\nBackground Color
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sortable_order","full_name":"sortable_order","description":"\nTranslation missing: en.api.tokens.sortable_order
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" \"https://[your-subdomain].trackdrive.com/api/v1/tokens/1\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/destroy","name":"destroy","apis":[{"api_url":"/api/v1/tokens/:id","http_method":"DELETE","short_description":"Destroy Token by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE \"https://[your-subdomain].trackdrive.com/api/v1/tokens/:id\""],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/tokens/fields","name":"fields","apis":[{"api_url":"/api/v1/tokens/fields","http_method":"GET","short_description":"Get Token by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"lead_token","full_name":"lead_token","description":"\nTranslation missing: en.api.lead_token
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"trackdrive_table_collections":{"doc_url":"/api/docs/1.0/trackdrive_table_collections","id":"trackdrive_table_collections","api_url":"/api","name":"Trackdrive Table Collection","short_description":"API resource for managing Trackdrive Table Collection.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/trackdrive_table_collections/index","name":"index","apis":[{"api_url":"/api/v1/trackdrive_table_collections","http_method":"GET","short_description":"List Trackdrive Table Collection records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
User
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"slug","full_name":"slug","description":"\nSlug
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/create","name":"create","apis":[{"api_url":"/api/v1/trackdrive_table_collections","http_method":"POST","short_description":"Create Trackdrive Table Collection.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\nUser
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"slug","full_name":"slug","description":"\nSlug
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/show","name":"show","apis":[{"api_url":"/api/v1/trackdrive_table_collections/:id","http_method":"GET","short_description":"Get Trackdrive Table Collection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/update","name":"update","apis":[{"api_url":"/api/v1/trackdrive_table_collections/:id","http_method":"PUT","short_description":"Update Trackdrive Table Collection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\nUser
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"slug","full_name":"slug","description":"\nSlug
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nCreated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nUpdated At
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_table_collections/destroy","name":"destroy","apis":[{"api_url":"/api/v1/trackdrive_table_collections/:id","http_method":"DELETE","short_description":"Destroy Trackdrive Table Collection by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"trackdrive_tables":{"doc_url":"/api/docs/1.0/trackdrive_tables","id":"trackdrive_tables","api_url":"/api","name":"Trackdrive Table","short_description":"API resource for managing Trackdrive Table.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/trackdrive_tables/index","name":"index","apis":[{"api_url":"/api/v1/trackdrive_tables","http_method":"GET","short_description":"List Trackdrive Table records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"name":"trackdrive_table_collection_id","full_name":"trackdrive_table_collection_id","description":"\nTrackdrive Table Collection
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/create","name":"create","apis":[{"api_url":"/api/v1/trackdrive_tables","http_method":"POST","short_description":"Create Trackdrive Table.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trackdrive_table_collection_id","full_name":"trackdrive_table_collection_id","description":"\nTrackdrive Table Collection
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/show","name":"show","apis":[{"api_url":"/api/v1/trackdrive_tables/:id","http_method":"GET","short_description":"Get Trackdrive Table by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/update","name":"update","apis":[{"api_url":"/api/v1/trackdrive_tables/:id","http_method":"PUT","short_description":"Update Trackdrive Table by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\nName
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"trackdrive_table_collection_id","full_name":"trackdrive_table_collection_id","description":"\nTrackdrive Table Collection
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/trackdrive_tables/destroy","name":"destroy","apis":[{"api_url":"/api/v1/trackdrive_tables/:id","http_method":"DELETE","short_description":"Destroy Trackdrive Table by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"traffic_sources":{"doc_url":"/api/docs/1.0/traffic_sources","id":"traffic_sources","api_url":"/api","name":"Traffic Sources","short_description":"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\nTranslation missing: en.api.user_traffic_source_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"first_name","full_name":"first_name","description":"\nTranslation missing: en.api.first_name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\nTranslation missing: en.api.last_name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"company_name","full_name":"company_name","description":"\nTranslation missing: en.api.company_name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_limit","full_name":"number_limit","description":"\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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"user_traffic_source_id\":\"xyz\",\"first_name\":\"name\", \"generate_team\":\"true\", team_users_emails: [\"john-smith@gmail.com\"], team_offer_ids: [58923]}' https://[your-subdomain].trackdrive.com/api/v1/traffic_sources"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_sources/show","name":"show","apis":[{"api_url":"/api/v1/traffic_sources/:id","http_method":"GET","short_description":"Get Traffic Source by id.","deprecated":null}],"formats":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":"\nTranslation missing: en.api.user_traffic_source_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"first_name","full_name":"first_name","description":"\nTranslation missing: en.api.first_name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\nTranslation missing: en.api.last_name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"company_name","full_name":"company_name","description":"\nTranslation missing: en.api.company_name
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_limit","full_name":"number_limit","description":"\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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X PUT -d '{\"user_traffic_source_id\":\"new_user_ts_id\",\"first_name\":\"new name\"}' https://[your-subdomain].trackdrive.com/api/v1/traffic_sources/:id"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/traffic_sources/destroy","name":"destroy","apis":[{"api_url":"/api/v1/traffic_sources/:id","http_method":"DELETE","short_description":"Destroy Traffic Source by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X DELETE https://[your-subdomain].trackdrive.com/api/v1/traffic_sources/:id"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcription_flow_groups":{"doc_url":"/api/docs/1.0/transcription_flow_groups","id":"transcription_flow_groups","api_url":"/api","name":"Transcription Flow Group","short_description":"API resource for managing Transcription Flow Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcription_flow_groups/index","name":"index","apis":[{"api_url":"/api/v1/transcription_flow_groups","http_method":"GET","short_description":"List Transcription Flow Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flow_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/transcription_flow_groups/:id","http_method":"DELETE","short_description":"Destroy Transcription Flow Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcription_flows":{"doc_url":"/api/docs/1.0/transcription_flows","id":"transcription_flows","api_url":"/api","name":"Transcription Flow","short_description":"API resource for managing Transcription Flow.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcription_flows/index","name":"index","apis":[{"api_url":"/api/v1/transcription_flows","http_method":"GET","short_description":"List Transcription Flow records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/create","name":"create","apis":[{"api_url":"/api/v1/transcription_flows","http_method":"POST","short_description":"Create Transcription Flow.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/show","name":"show","apis":[{"api_url":"/api/v1/transcription_flows/:id","http_method":"GET","short_description":"Get Transcription Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/update","name":"update","apis":[{"api_url":"/api/v1/transcription_flows/:id","http_method":"PUT","short_description":"Update Transcription Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"transcription_flow_group_id","full_name":"transcription_flow_group_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_flows/destroy","name":"destroy","apis":[{"api_url":"/api/v1/transcription_flows/:id","http_method":"DELETE","short_description":"Destroy Transcription Flow by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcription_keyword_groups":{"doc_url":"/api/docs/1.0/transcription_keyword_groups","id":"transcription_keyword_groups","api_url":"/api","name":"Keyword Group","short_description":"API resource for managing Keyword Group.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcription_keyword_groups/index","name":"index","apis":[{"api_url":"/api/v1/transcription_keyword_groups","http_method":"GET","short_description":"List Keyword Group records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keyword_groups/destroy","name":"destroy","apis":[{"api_url":"/api/v1/transcription_keyword_groups/:id","http_method":"DELETE","short_description":"Destroy Keyword Group by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcription_keywords":{"doc_url":"/api/docs/1.0/transcription_keywords","id":"transcription_keywords","api_url":"/api","name":"Transcription Keyword","short_description":"API resource for managing Transcription Keyword.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcription_keywords/index","name":"index","apis":[{"api_url":"/api/v1/transcription_keywords","http_method":"GET","short_description":"List Transcription Keyword records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"name":"operator","full_name":"operator","description":"\nOperator
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"values","full_name":"values","description":"\nValues
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"name":"operator","full_name":"operator","description":"\nOperator
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"values","full_name":"values","description":"\nValues
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"name":"operator","full_name":"operator","description":"\nOperator
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"values","full_name":"values","description":"\nValues
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/transcription_keywords/destroy","name":"destroy","apis":[{"api_url":"/api/v1/transcription_keywords/:id","http_method":"DELETE","short_description":"Destroy Transcription Keyword by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"transcriptions":{"doc_url":"/api/docs/1.0/transcriptions","id":"transcriptions","api_url":"/api","name":"Transcription","short_description":"API resource for managing Transcription.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/transcriptions/index","name":"index","apis":[{"api_url":"/api/v1/transcriptions","http_method":"GET","short_description":"List Transcription records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"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":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/unblock_contact_jobs/show","name":"show","apis":[{"api_url":"/api/v1/unblock_contact_jobs/:id","http_method":"GET","short_description":"Get Clear Blacklist by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/unblock_contact_jobs/destroy","name":"destroy","apis":[{"api_url":"/api/v1/unblock_contact_jobs/:id","http_method":"DELETE","short_description":"Destroy Clear Blacklist by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"uncompleted_calls":{"doc_url":"/api/docs/1.0/uncompleted_calls","id":"uncompleted_calls","api_url":"/api","name":"Uncompleted Calls","short_description":"API resource for managing Uncompleted Calls.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/uncompleted_calls/index","name":"index","apis":[{"api_url":"/api/v1/uncompleted_calls","http_method":"GET","short_description":"List Uncompleted Calls records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":["curl -H \"Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY\" -H \"Content-Type: application/json\" -X POST -d '{\"offer_id\": 123,\"traffic_source_id\": 2345, \"number\":\"+18001231234\"}' https://[your-subdomain].trackdrive.com/api/v1/virtual_numbers"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/virtual_numbers/show","name":"show","apis":[{"api_url":"/api/v1/virtual_numbers/:id","http_method":"GET","short_description":"Get Virtual Number by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/virtual_numbers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/virtual_numbers/:id","http_method":"DELETE","short_description":"Destroy Virtual Number by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"visitor_token_matchers":{"doc_url":"/api/docs/1.0/visitor_token_matchers","id":"visitor_token_matchers","api_url":"/api","name":"Offers: Impression Tokens","short_description":"Define the unique url parameters that will be tracked when using Dynamic Number Insertion For example google clickIDs can be tracked: gclid\n","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/visitor_token_matchers/index","name":"index","apis":[{"api_url":"/api/v1/visitor_token_matchers","http_method":"GET","short_description":"List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\nTranslation missing: en.api.visitor_token_matchers.offer_id
\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/create","name":"create","apis":[{"api_url":"/api/v1/visitor_token_matchers","http_method":"POST","short_description":"Create record.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\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":[]},{"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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/show","name":"show","apis":[{"api_url":"/api/v1/visitor_token_matchers/:id","http_method":"GET","short_description":"Get record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/update","name":"update","apis":[{"api_url":"/api/v1/visitor_token_matchers/:id","http_method":"PUT","short_description":"Update record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"token","full_name":"token","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/visitor_token_matchers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/visitor_token_matchers/:id","http_method":"DELETE","short_description":"Destroy record by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"webhook_logs":{"doc_url":"/api/docs/1.0/webhook_logs","id":"webhook_logs","api_url":"/api","name":"Outgoing Webhooks: Logs","short_description":"API resource for viewing Webhook Request Logs.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/webhook_logs/index","name":"index","apis":[{"api_url":"/api/v1/webhook_logs","http_method":"GET","short_description":"List Webhook Logs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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: {}}
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":[]},{"name":"call_id","full_name":"call_id","description":"\nCall
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nTranslation missing: en.api.webhook_manual_fires.created_at
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nTranslation missing: en.api.webhook_manual_fires.updated_at
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_manual_fires/create","name":"create","apis":[{"api_url":"/api/v1/webhook_manual_fires","http_method":"POST","short_description":"Manually Fire A Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"outgoing_webhook_id","full_name":"outgoing_webhook_id","description":"\nOutgoing Webhook
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Trigger}[/api/docs/1.0/outgoing_webhooks/index.html]. Refer to: {/api/docs/1.0/outgoing_webhooks}[/api/docs/1.0/outgoing_webhooks/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"buyer_conversion_id","full_name":"buyer_conversion_id","description":"\nTranslation missing: en.api.webhook_manual_fires.buyer_conversion_id
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Buyer Conversion}[/api/docs/1.0/buyer_conversions/index.html]. Refer to: {/api/docs/1.0/buyer_conversions}[/api/docs/1.0/buyer_conversions/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lead_id","full_name":"lead_id","description":"\nLead
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Lead}[/api/docs/1.0/leads/index.html]. Refer to: {/api/docs/1.0/leads}[/api/docs/1.0/leads/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"call_id","full_name":"call_id","description":"\nCall
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Call}[/api/docs/1.0/calls/index.html]. Refer to: {/api/docs/1.0/calls}[/api/docs/1.0/calls/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\nTranslation missing: en.api.webhook_manual_fires.created_at
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"updated_at","full_name":"updated_at","description":"\nTranslation missing: en.api.webhook_manual_fires.updated_at
\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid time: 2025-07-13 09:51:11 +0000","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_manual_fires/show","name":"show","apis":[{"api_url":"/api/v1/webhook_manual_fires/:id","http_method":"GET","short_description":"Get A Manually Fired Webhook","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"webhook_params":{"doc_url":"/api/docs/1.0/webhook_params","id":"webhook_params","api_url":"/api","name":"Webhook Param","short_description":"API resource for managing Webhook Param.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/webhook_params/index","name":"index","apis":[{"api_url":"/api/v1/webhook_params","http_method":"GET","short_description":"List Webhook Param records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/webhook_params/destroy","name":"destroy","apis":[{"api_url":"/api/v1/webhook_params/:id","http_method":"DELETE","short_description":"Destroy Webhook Param by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"zip_code_list_files":{"doc_url":"/api/docs/1.0/zip_code_list_files","id":"zip_code_list_files","api_url":"/api","name":"Zip Code Lists: CSV Files","short_description":"API resource for managing Zip CSV File.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/zip_code_list_files/index","name":"index","apis":[{"api_url":"/api/v1/zip_code_list_files","http_method":"GET","short_description":"List Zip CSV File records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]}],"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":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_list_files/destroy","name":"destroy","apis":[{"api_url":"/api/v1/zip_code_list_files/:id","http_method":"DELETE","short_description":"Destroy Zip CSV File by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"zip_code_lists":{"doc_url":"/api/docs/1.0/zip_code_lists","id":"zip_code_lists","api_url":"/api","name":"Zip Code Lists","short_description":"API resource for managing Zip Code List.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/zip_code_lists/index","name":"index","apis":[{"api_url":"/api/v1/zip_code_lists","http_method":"GET","short_description":"List Zip Code List records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]}],"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":[]},{"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":[]}],"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":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/zip_code_lists/destroy","name":"destroy","apis":[{"api_url":"/api/v1/zip_code_lists/:id","http_method":"DELETE","short_description":"Destroy Zip Code List by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"zoho_crm_commands":{"doc_url":"/api/docs/1.0/zoho_crm_commands","id":"zoho_crm_commands","api_url":"/api","name":"Zoho Action","short_description":"API resource for managing Zoho Action.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/zoho_crm_commands/index","name":"index","apis":[{"api_url":"/api/v1/zoho_crm_commands","http_method":"GET","short_description":"List Zoho Action records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"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":[]},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a 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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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":[]},{"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":[]},{"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":[]},{"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":[]}],"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}}}}