Moving Leads Submission API


Parameter Value Description Example Data Type

Tier 1 - Mandatory Parameters This tier includes the most crucial information needed to initiate and process the moving lead.
apikey A unique identifier used to authenticate requests to the API. It represents a specific department, web campaign, or landing page within a company, ensuring that data is correctly attributed and segregated for analysis. 168D4363-0468-4308-A2F6-C7ED2F684037 string
firstname The first name of the consumer or shipper. Jennifer string
lastname The last name of the consumer or shipper. Drago string
email The email address of the consumer or shipper. jennife@drago.com string
mobile The mobile phone number of the consumer or shipper. 212-555-1212 string
fromzipcode The zipcode of the origin location. 33140 string
tozipcode The zipcode of the destination location. 10020 string
pickupdate1 The requested date for pickup. 02/29/2024 date

Tier 2 - Essential Parameters This tier comprises important information that, while not mandatory, is vital for a smooth operation and better service customization
sourcereference Identifier, description, or name of the landing page or form where the lead came from - this data can be retrieved in reports! BING_101 string
movesizecode Text field to describe the size of the move:
studio - Studio , one - One bedroom , two - Two bedrooms , three - Three bedrooms , four - Four bedrooms , five - Five bedrooms , six - Six bedrooms , seven - Seven bedrooms , office - Office , few - Few Items , 20ft - 20 ft Container , 40ft - 40 ft Container , other - Other
three string
jobsize Size of the job. 800 numeric
jobsizecode Unit of measurement for the job size. Options: cf (cubic feet), lb (pounds), cbm (cubic meters), kg (kilograms). cf string
consumernote Field for the consumer or shipper to leave comments. Having a garage sale. The number of items for delivery is expected to decrease string
tagcode Used to attach a specific tag to the lead for categorization or tracking purposes. STG_NY string
redirecturl The URL to which to redirect after posting (typically a "Thank You" page). www.granot.com string

Tier 3 - Additional Information These parameters provide extra context or information that can improve service understanding, planning, or customer experience but are not critical for the basic processing of the lead
pickupdate2 An alternate requested date for pickup. date
deliverydate1 The requested date for delivery. 02/29/2024 date
deliverydate2 An alternate requested date for delivery. date
fromformattedaddress Full, formatted address of the origin location. string
fromaddressdescription Additional details or description of the origin location. string
toformattedaddress Full, formatted address of the destination location. string
toaddressdescription Additional details or description of the destination location. string
isemail A boolean field indicating whether the consumer or shipper has consented to receive email communications. A value of `true` signifies consent. Users can opt out at any time by clicking on the `UNSUBSCRIBE` link typically found in email communications 1 (Yes) numeric
issms A boolean field indicating whether the consumer or shipper has consented to receive text messages. A value of `true` means they have agreed to this form of communication. Opting out can be done by texting keywords like CANCEL, END, QUIT, UNSUBSCRIBE, STOP, or STOPALL. 1 (Yes) numeric
phone1 The consumer`s or shipper`s primary phone number. 212-555-3434 string
phone2 The consumer`s or shipper`s secondary phone number. 212-555-5656 varchar 20
fax The consumer`s or shipper`s fax number. varchar 20
consumertypeid Identifier for the type of consumer or shipper. Options: 11 - Residential, 12 - Commercial, 14 - Government, 13 - Military, 15 - On Account. 11 (Residential) numeric
priorityid Identifier for the priority level of the lead. 1 , 2 , 3 , 4 , or 5 . 1 numeric

Tier 4 - Utility and Customized Information This tier includes parameters that offer utility, customization, and personal preferences. They are useful for tailoring the service to specific needs or for additional services that are not part of the standard process
fromcountryid The ISO 3166 country code corresponding to the origin location. 36 - AU , 124 - CA , 276 - DE , 484 - MX , 528 - NL , 826 - GB , 840 - US ... 840 (US) numeric
fromstate Identifier for the state of origin:
US (840) - AL, CA, FL, TX, NY, ...
CA (124) - AB, BC, ON, QC, NS, ...
AU (36) - NSW, QLD, SA, VIC, ...
GB (826) - ENG, WLS, NIR, SCT.
FL string
fromregion Identifier for the region of origin:
GB (826) - NE, NW, YH, EE, LDN, ...
LDN string
tocountryid The ISO 3166 country code corresponding to the origin location. 36 - AU , 124 - CA , 276 - DE , 484 - MX , 528 - NL , 826 - GB , 840 - US ... 840 (US) numeric
tostate Identifier for the state of destination:
US (840) - AL, CA, FL, TX, NY, ...
CA (124) - AB, BC, ON, QC, NS, ...
AU (36) - NSW, QLD, SA, VIC, ...
GB (826) - ENG, WLS, NIR, SCT.
NY string
toregion Identifier for the region of destination:
GB (826) - NE, NW, YH, EE, LDN, ...
EE string
languageid 840 - English US, 826 - English GB, 528 - Dutch, 276- German , 250 - French, 724 - Spanish ES ... 11 (English) numeric
servicetypeid Identifier for the type of service required. Options: 101 - Local Move, 102 - Long Distance Move, 103 - Auto Transport, 104 - International, 105 - Storage. 102 (Long Distance) numeric
mobilecallingcode The ISO 3166 country code corresponding to the consumer`s or shipper`s mobile phone. 1 - US/CA , 44 - GB , 31 - NL , 61 - AU , 49 - GB ... 1 numeric

Tier 5 - Leads Providers Direct post and Leads Market
customerapikey This parameter refers to the unique key assigned to a specific customer in the leads market. It is used to identify and authenticate the customer who will receive the lead. leads@movingcompant.com or 33554BA550D9 string
sourceidentifier It is a unique reference associated with the order within the provider system. This identifier serves as a critical link between the lead submitted and the corresponding record in the provider`s database. string
sourcenote Field for additional information that doesn`t fit into the other parameters. string
ipaddress The IP address of the source or origin of the lead. 64.233.160.0 varchar 50
marketamount This parameter represents the price set for a lead in the market. It indicates the monetary value associated with a single lead. The marketamount determines the cost that the customer needs to pay in order to acquire the lead 8.25 numeric
minimumamount The minimumamount parameter specifies the lowest purchase amount required for a lead if the lead price varies 4.95 numeric
maximumamount The maximumamount parameter denotes the highest purchase amount allowed for a lead if the lead price varies 12.5 numeric
maximumdistribution This parameter defines the maximum number of times a lead can be sold or distributed to different customers 3 numeric