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 Longitude 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. Use dash to separate multiple values.
hinc-d string Household income for residential search. Use dash to separate multiple values.
worth-d string Net worth for residential search. Use dash to separate multiple values.
Home-d string Home value for residential search. Use dash to separate multiple values.
resLen-d string Length of residency for residential search. Use dash to separate multiple values.
hAge string Household age for residential search. Use dash to separate multiple values.
people string People in household for residential search. Use dash to separate multiple values.
kids string Children in household for residential search. Use dash to separate multiple values.
marital string Marital status for residential search. Use dash to separate multiple values.
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 Handwriting font slug
font_size integer Font size

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