{"docs":{"name":"TrackDrive","info":"\n\u003cp\u003eTrackdrive API Reference\u003c/p\u003e\n","copyright":null,"doc_url":"/api/docs/1.0","api_url":"/api","resources":[{"doc_url":"/api/docs/1.0/offers","id":"offers","api_url":"/api","name":"Offers","short_description":"The set of offers in your account.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/offers/index","name":"index","apis":[{"api_url":"/api/v1/offers","http_method":"GET","short_description":"List Offer records.","deprecated":null}],"formats":["json","csv"],"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort results by this field.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003eschedules_count\u003c/code\u003e, \u003ccode\u003enumbers_count\u003c/code\u003e, \u003ccode\u003ebuyers_count\u003c/code\u003e, \u003ccode\u003eagents_count\u003c/code\u003e, \u003ccode\u003epaused\u003c/code\u003e, \u003ccode\u003euser_offer_id\u003c/code\u003e, \u003ccode\u003ecalls_count\u003c/code\u003e, \u003ccode\u003erecent_calls_count\u003c/code\u003e, \u003ccode\u003elast_call_at\u003c/code\u003e, \u003ccode\u003enumbers_count\u003c/code\u003e, \u003ccode\u003ecreated_at\u003c/code\u003e, \u003ccode\u003edata_append_type\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order_dir","full_name":"order_dir","description":"\n\u003cp\u003eSort results in ascending or descending order.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003easc\u003c/code\u003e, \u003ccode\u003edesc\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_offer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\npaused\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_api_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nleads_api_key\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nnumbers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_cc_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nactive_cc_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nin_progress_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_routers_attributes\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlead_token\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_conversion_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyers_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_groups_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nagents_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvertical_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvertical_options\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_blacklist_alliance_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_blacklist_alliance_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_blacklist_alliance_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_tcpa_shield_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_tcpa_shield_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_tcpa_shield_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_suppression_list_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_suppression_list_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_suppression_list_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/show","name":"show","apis":[{"api_url":"/api/v1/offers/:id","http_method":"GET","short_description":"Get Offer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/new","name":"new","apis":[{"api_url":"/api/v1/offers/new","http_method":"GET","short_description":"Build Offer with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/create","name":"create","apis":[{"api_url":"/api/v1/offers","http_method":"POST","short_description":"Create Offer.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eGive this offer a name. Example: Insurance Calls\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_offer_id","full_name":"user_offer_id","description":"\n\u003cp\u003eGive this offer a unique ID. Example: IC001\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of the record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause the offer. Paused offers will reject all calls and disable all schedules.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls","full_name":"record_calls","description":"\n\u003cp\u003eRecord Calls\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls_require_authorization","full_name":"record_calls_require_authorization","description":"\n\u003cp\u003eRequire the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_id","full_name":"vertical_id","description":"\n\u003cp\u003eThe Vertical assigned to this offer, used for reporting and Vertical-scoped enrichment.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_behaviour","full_name":"callback_behaviour","description":"\n\u003cp\u003eHow a caller who calls back the same offer is routed. One of \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003eforce_previous_buyer\u003c/code\u003e, or \u003ccode\u003eforce_new_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enormal\u003c/th\u003e\u003ctd\u003eNormal\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eforce_previous_buyer\u003c/th\u003e\u003ctd\u003eForce Previous Buyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eforce_new_buyer\u003c/th\u003e\u003ctd\u003eForce New Buyer\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_timeframe","full_name":"callback_reconnect_timeframe","description":"\n\u003cp\u003eThe number of seconds after a call ends during which a callback is still treated as a repeat call for routing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_buyer_ids","full_name":"callback_reconnect_buyer_ids","description":"\n\u003cp\u003eThe buyer IDs eligible to receive a reconnected callback. If blank, no buyers are reconnected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_behaviour","full_name":"callback_reconnect_behaviour","description":"\n\u003cp\u003eThe action taken once the reconnect timeframe has passed, for example \u003ccode\u003eforce_new_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_anonymous_ignore_duplicate_timeframe","full_name":"callback_anonymous_ignore_duplicate_timeframe","description":"\n\u003cp\u003eWhen true, calls from anonymous caller IDs are treated as unique calls instead of being matched to a previous call for the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_without_dupe","full_name":"callback_reconnect_without_dupe","description":"\n\u003cp\u003eWhen true, a call is not sent to a buyer who already converted a call from the same caller within the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_without_repeat","full_name":"callback_reconnect_without_repeat","description":"\n\u003cp\u003eWhen true, a call is not sent to a buyer who already answered a call from the same caller within the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_contact_field_validations","full_name":"enforce_contact_field_validations","description":"\n\u003cp\u003eWhen true, leads submitted to this offer must pass the offer’s contact field validations before they are accepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eWhen true, a lead submitted to this offer must include a \u003ccode\u003etraffic_source_id\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_traffic_source_reject_duplicates","full_name":"lead_traffic_source_reject_duplicates","description":"\n\u003cp\u003eWhen true, a lead is rejected if it duplicates an existing lead from the same traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_lead_contact_field_keys","full_name":"enforce_lead_contact_field_keys","description":"\n\u003cp\u003eWhen true, only the contact field keys configured on this offer are accepted on lead submission.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minimum_caller_number_length","full_name":"minimum_caller_number_length","description":"\n\u003cp\u003eThe minimum number of digits accepted in an inbound caller’s phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_caller_number_length","full_name":"maximum_caller_number_length","description":"\n\u003cp\u003eThe maximum number of digits accepted in an inbound caller’s phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n\u003cp\u003eThe Map Contact Field Groups applied to leads submitted to this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Contact Field Mapping Group}[/api/docs/1.0/map_contact_field_groups/index.html]. Refer to: {/api/docs/1.0/map_contact_field_groups}[/api/docs/1.0/map_contact_field_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_expire_in_months","full_name":"leads_expire_in_months","description":"\n\u003cp\u003eThe number of months a lead remains active before it is automatically archived and removed from delivery.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003eWhen true, this offer’s public posting instructions page is reachable at its posting instructions link.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eWhen true, this offer is listed on the public posting instructions index page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe title shown on this offer’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe HTML description shown on this offer’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/update","name":"update","apis":[{"api_url":"/api/v1/offers/:id","http_method":"PUT","short_description":"Update Offer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reset_numbers_api_key","full_name":"reset_numbers_api_key","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eGive this offer a name. Example: Insurance Calls\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_offer_id","full_name":"user_offer_id","description":"\n\u003cp\u003eGive this offer a unique ID. Example: IC001\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eA human readable description of the record.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paused","full_name":"paused","description":"\n\u003cp\u003ePause or unpause the offer. Paused offers will reject all calls and disable all schedules.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls","full_name":"record_calls","description":"\n\u003cp\u003eRecord Calls\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_calls_require_authorization","full_name":"record_calls_require_authorization","description":"\n\u003cp\u003eRequire the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_id","full_name":"vertical_id","description":"\n\u003cp\u003eThe Vertical assigned to this offer, used for reporting and Vertical-scoped enrichment.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_behaviour","full_name":"callback_behaviour","description":"\n\u003cp\u003eHow a caller who calls back the same offer is routed. One of \u003ccode\u003enormal\u003c/code\u003e, \u003ccode\u003eforce_previous_buyer\u003c/code\u003e, or \u003ccode\u003eforce_new_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enormal\u003c/th\u003e\u003ctd\u003eNormal\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eforce_previous_buyer\u003c/th\u003e\u003ctd\u003eForce Previous Buyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eforce_new_buyer\u003c/th\u003e\u003ctd\u003eForce New Buyer\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_timeframe","full_name":"callback_reconnect_timeframe","description":"\n\u003cp\u003eThe number of seconds after a call ends during which a callback is still treated as a repeat call for routing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_buyer_ids","full_name":"callback_reconnect_buyer_ids","description":"\n\u003cp\u003eThe buyer IDs eligible to receive a reconnected callback. If blank, no buyers are reconnected.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_behaviour","full_name":"callback_reconnect_behaviour","description":"\n\u003cp\u003eThe action taken once the reconnect timeframe has passed, for example \u003ccode\u003eforce_new_buyer\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_anonymous_ignore_duplicate_timeframe","full_name":"callback_anonymous_ignore_duplicate_timeframe","description":"\n\u003cp\u003eWhen true, calls from anonymous caller IDs are treated as unique calls instead of being matched to a previous call for the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_without_dupe","full_name":"callback_reconnect_without_dupe","description":"\n\u003cp\u003eWhen true, a call is not sent to a buyer who already converted a call from the same caller within the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"callback_reconnect_without_repeat","full_name":"callback_reconnect_without_repeat","description":"\n\u003cp\u003eWhen true, a call is not sent to a buyer who already answered a call from the same caller within the duplicate timeframe.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_contact_field_validations","full_name":"enforce_contact_field_validations","description":"\n\u003cp\u003eWhen true, leads submitted to this offer must pass the offer’s contact field validations before they are accepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_traffic_source_id","full_name":"require_traffic_source_id","description":"\n\u003cp\u003eWhen true, a lead submitted to this offer must include a \u003ccode\u003etraffic_source_id\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"lead_traffic_source_reject_duplicates","full_name":"lead_traffic_source_reject_duplicates","description":"\n\u003cp\u003eWhen true, a lead is rejected if it duplicates an existing lead from the same traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enforce_lead_contact_field_keys","full_name":"enforce_lead_contact_field_keys","description":"\n\u003cp\u003eWhen true, only the contact field keys configured on this offer are accepted on lead submission.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minimum_caller_number_length","full_name":"minimum_caller_number_length","description":"\n\u003cp\u003eThe minimum number of digits accepted in an inbound caller’s phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum_caller_number_length","full_name":"maximum_caller_number_length","description":"\n\u003cp\u003eThe maximum number of digits accepted in an inbound caller’s phone number.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"map_contact_field_group_ids","full_name":"map_contact_field_group_ids","description":"\n\u003cp\u003eThe Map Contact Field Groups applied to leads submitted to this offer.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Contact Field Mapping Group}[/api/docs/1.0/map_contact_field_groups/index.html]. Refer to: {/api/docs/1.0/map_contact_field_groups}[/api/docs/1.0/map_contact_field_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"leads_expire_in_months","full_name":"leads_expire_in_months","description":"\n\u003cp\u003eThe number of months a lead remains active before it is automatically archived and removed from delivery.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_show","full_name":"enable_public_show","description":"\n\u003cp\u003eWhen true, this offer’s public posting instructions page is reachable at its posting instructions link.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enable_public_index","full_name":"enable_public_index","description":"\n\u003cp\u003eWhen true, this offer is listed on the public posting instructions index page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_name","full_name":"public_name","description":"\n\u003cp\u003eThe title shown on this offer’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"public_description","full_name":"public_description","description":"\n\u003cp\u003eThe HTML description shown on this offer’s public posting instructions page.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/offers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/offers/:id","http_method":"DELETE","short_description":"Destroy Offer by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serializer","full_name":"serializer","description":"\n\u003cp\u003eThis endpoint supports multiple response formats. Pass \u003ccode\u003eserializer=name\u003c/code\u003e to retrieve data in an alternate format.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eoffer\u003c/th\u003e\u003ctd\u003eDefault response format.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoffer_grid\u003c/th\u003e\u003ctd\u003eModern response format that returns various foreign keys for use with other API endpoints.\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etranscription_offer_config\u003c/th\u003e\u003ctd\u003eTranscription Offer Config\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}]}}