API ReferenceAutomations
Post a request for Proximity search around point (lat, lng)
Post a request for Proximity search around an address tied to specified integration order
Post a request for Proximity search around an address tied to specified integration order
Authorization
ApiKey X-API-KEY<token>
In: header
Path Parameters
id*integer
ID of integration order add recipients to.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Name*string
OwnerOrRenterFilter*integer
PropertyTypeFilter*integer
HouseHoldIncomeFilter*
LengthOfResidenceFilter*
YearBuiltFilter*
HomePriceFilter*
Addresses*array<>
MultiUse*boolean|null
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/integration-orders/0-by-proximity" \ -H "Content-Type: application/json" \ -d '{ "Name": "string", "OwnerOrRenterFilter": 0, "PropertyTypeFilter": 0, "HouseHoldIncomeFilter": { "min": 0, "max": 0 }, "LengthOfResidenceFilter": { "min": 0, "max": 0 }, "YearBuiltFilter": { "min": 0, "max": 0 }, "HomePriceFilter": { "min": 0, "max": 0 }, "Addresses": [ { "address1": "string", "address2": "string", "city": "string", "state": "string", "zip": "string", "DesiredCount": 0 } ], "MultiUse": true }'{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "id": 0, "name": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "postageType": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "id": 0, "name": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "postageType": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "id": 0, "name": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "postageType": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "id": 0, "name": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "postageType": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}