Create Order

Add prospecting campaign order to basket. Use Send Basket call to submit all orders in basket for processing.

Request Body
address string Street address to serve as a central point for prospecting search.
city string Format: STATE;City
zip string Postal code
country string United States or Canada
radius integer Search radius in miles from the central point.
latitude string Latitude to serve as a central point for prospecting search. If not using latitude and longitude, set them to 1. We use them for a secondary search if nothing was found at the address.
longitude string Longtitude to serve as a central point for prospecting search. If not using latitude and longitude, set them to 1. We use them for a secondary search if nothing was found at the address.
mask boolean If no data was found at the address, try searching by geodata
ownRent-d string Home ownership for residential search. 1: Home owner 2: Renter If you want to use multiple values, use dash to separate them, for example: "ownRent-d": "1-2"
hinc-d string Household income for residential search. 1: Less than $14,999 2: $15,000 - $19,999 3: $20,000 - $29,999 4: $30,000 - $39,999 5: $40,000 - $49,999 6: $50,000 - $74,999 7: $75,000 - $99,999 8: $100,000 - $124,999 9: $125,000 - $149,999 10: $150,000 - $174,999 11: $175,000 - $199,999 12: $200,000 - $249,999 13: $250,000 or more If you want to use multiple values, use dash to separate them, for example: "hinc-d": "2-3-4-5-6"
worth-d string Net worth for residential search. 1: Less than $25,000 2: $25,000 - $49,999 3: $50,000 - $74,999 4: $75,000 - $99,999 5: $100,000 - $149,999 6: $150,000 - $249,999 7: $250,000 - $499,999 8: $500,000 - $749,999 9: $750,000 - $999,999 10: $1,000,000 or more If you want to use multiple values, use dash to separate them, for example: "worth-d": "6-8-9"
Home-d string Home value for residential search. 1: $1 - $49,999 2: $50,000 - $99,999 3: $100,000 - $149,999 4: $150,000 - $199,999 5: $200,000 - $249,999 6: $250,000 - $299,999 7: $300,000 - $349,999 8: $350,000 - $399,999 9: $400,000 - $449,999 10: $450,000 - $499,999 11: $500,000 - $574,999 12: $575,000 - $649,999 13: $650,000 - $724,999 14: $725,000 - $799,999 15: $800,000 - $899,999 16: $900,000 - $999,999 17: $1,000,000 - $1,999,999 18: $2,000,000 or More If you want to use multiple values, use dash to separate them, for example: "Home-d": "3-4-5-8-9"
resLen-d string Length of residency for residential search. 1: 0-6 months 2: 7-12 months 3: 1-2 years 4: 3-5 years 5: 6-10 years 6: 11-15 years 7: 16-20 years 8: 20+ years If you want to use multiple values, use dash to separate them, for example: "resLen-d": "1-3-4-5-8"
hAge string Household age for residential search. 1: 18-24 years old 2: 25-34 years old 3: 35-44 years old 4: 45-54 years old 5: 55-64 years old 6: 65-74 years old 7: 75+ years old If you want to use multiple values, use dash to separate them, for example: "hAge-d": "1-3-4-5"
people string People in household for residential search. 1: 1 person 2: 2 persons 3: 3 persons 4: 4 persons 5: 5 persons 6: 6 persons 7: 7 persons 8: 8 persons 9: 9+ persons If you want to use multiple values, use dash to separate them, for example: "people-d": "4-5"
kids string Children in household for residential search. 1: 1 child 2: 2 children 3: 3 children 4: 4 children 5: 5 children 6: 6 Chidlren 7: 7 children 8: 8 children 9: 9+ children If you want to use multiple values, use dash to separate them, for example: "kids-d": "4-7-8-5"
marital string Martial status for residential search. 1: Unknown 2: Household contains at least 1 married person 3: Household contains at least 1 single person 4: Household contains both married & single persons If you want to use multiple values, use dash to separate them, for example: "marital-d": "1-2"
card_id integer — REQUIRED ID of card
insert_id integer ID of the insert
message string — REQUIRED Handwrytten message on the card
wishes string Handwrytten signoff on the card
signature_id integer ID of the custom signature
signature2_id integer ID of the custom signature #2
search_value string Search value
must_deliver_by string Format: MM/DD/YYYY
records integer — REQUIRED Number of cards to send
return_address_id integer — REQUIRED ID of the return address
shipping_address_id integer ID of the shipping address
shipping_method_id integer Possible values: [1, 2, 3, 4, 5, 6] Shipping method. 1: Mail Normally 2: Ship: Address, Seal, Stamp 3: Ship: Cards Only (no envelope) 4: Ship: Cards Only (blank envelope unsealed) 5: Ship: Addressed & Unsealed 6: Ship: Addressed & Sealed
shipping_rate_id integer Possible values: [1, 2, 3, 4] Shipping rate. 1: Ground 2: 2-Day 3: Overnight 4: Overnight Priority
font string — REQUIRED Handwryting font slug
font_size integer Font size

Responses
200 OK Schema httpCode integer Possible values: [200] status string Possible values: [ok] order_id integer ID of order in basket
400 Bad Request Schema httpCode integer Possible values: [400] status string Possible values: [error] message string Error message
440 Login Timeout Schema httpCode integer Possible values: [440] status string Possible values: [error] message string Possible values: [Session has been expired.] Error message