Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Path Parameters

list_id
string
required

The lead list's id: the id from List lead lists. It is also the last part of that page's address in the app.

Body

application/json
locations
string[]
required

Locations returned by the Sendora API.

Required array length: 1 - 30 elements
query
string
required

Query returned by the Sendora API.

Required string length: 1 - 200
limit
integer
default:50

Limit returned by the Sendora API.

Required range: 1 <= x <= 500

Response

Successful Response

id
string<uuid>
required

The preview's id. Pass it as preview_id to read or import this result set.

results
Results · object[]
required

Results returned by the Sendora API.

status
string
required

Status returned by the Sendora API.

error_message
string | null

Error message returned by the Sendora API.