Mailing Lists

Radius Search

Changed on

This call will purchase a radius search mailing listing and add it to your account. Each record added to the mailing list costs $.05. You can specify the number of records to return (up to 2,500) and the address/postal code to center the search around. You can also specify a mailing_list_id to add the results to an existing mailing list, or leave it blank to create a new mailing list. While API/Zapier Test Mode is enabled on the account, this endpoint is limited to 5 records per purchase — test mode cancels orders, but buying a radius search is not an order and is charged in full, so the limit is what keeps an integration under development from buying a full list by accident.

post/mailing-lists-utils/buy-radius-search

Request

  • Base URL: https://api.thanks.io/api/v2
  • URL: https://api.thanks.io/api/v2/mailing-lists-utils/buy-radius-search
  • Auth: HTTP bearer

Request body

mailing_list_idinteger

ID of the mailing list to add the radius search results to. If not provided, a new mailing list will be created.

addressstring required

Street address to use for center of nearest neighbor search.

postal_codestring required

Postal code to use for center of nearest neighbor search.

record_countinteger required

Number of nearest neighbors to search for. While API/Zapier Test Mode is enabled on the account, a purchase through this endpoint is limited to 5 records; a larger value is refused with a 422 and nothing is bought or charged. Buying from the dashboard is not affected and keeps the full 2,500.

record_types'all' | 'likelytomove' | 'apartmentcomplex' | 'likelytodownsize' | 'likelytorefi' | 'absenteeowner' | 'highnetworth' | 'majorityhomeequity' | 'homefreeclear' | 'underwater' | 'kidsinhousehold' | 'newhomeowner' | 'firsttimehomebuyer' | 'renters' | 'retiring' | 'retired' | 'pool' | 'onlybusinesses' | 'newbusiness'

Which type of records to search for

include_condosboolean

Include condos in search.

append_databoolean

Append phone and email to each record for an additional fee ($.20 per record).

use_property_ownerboolean

Use Property Owners Address when searching for a commercial record_type.

include_search_addressboolean

Specifies whether to include the search address in the mailing list created.

Example request

{
  "mailing_list_id": 1,
  "address": "123 Main Street",
  "postal_code": "55555",
  "record_count": 1
}

Response

Successful Response

messagestring
mailing_list_idinteger
failureboolean

Example response

{
  "message": "success",
  "mailing_list_id": 1196
}

Changes

  • 63c911a0e3c5Revision changes
    • info

      the request property default value changed from false to true

    • info

      added the new apartmentcomplex enum value to the request property

    • info

      added the new likelytodownsize enum value to the request property

  • 1c53bf447639Revision changes
    • info

      added the non-success response with the status