Create a bulk leads job.

post

https://api.visualvisitor.com/api/v1/plusPerson/leads/bulkJob/create

Minimal scope required: "leads.read".
Queried customer must have a +PlusPerson plan enabled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerId

string | null

Optional query parameter, allowing partners to perform this action on behalf of their customer.

api-version

string | null

Body Params

The JSON object containing the job instruction and search filter.

Represents the data to create a bulk leads job.

page

int32 | null

Optional, the current page number for pagination, with a maximum allowed value of 50.
Not used for bulk operations.

pageSize

int32 | null

Optional, the number of records per page for pagination, with a maximum allowed value of 200.
Not used for bulk operations.

visitBeginDate

date-time | null

Optional, search by the start date of the visit range

visitEnddate

date-time | null

Optional, search by the start date of the visit range

firstName

string | null

Optional, search by the visitor's first name

lastName

string | null

Optional, search by the visitor's last name

emailAddress

string | null

Optional, search by the visitor's email address

genders

array of strings | null

Optional, search for visitors having a matching gender
Required values can be retrieved from the endpoint: /api/v1/reference/genders.

genders

ageRanges

array of strings | null

Optional, search for visitors within a matching age range
Required values can be retrieved from the endpoint: /api/v1/reference/ageRanges.

ageRanges

isMarried

boolean | null

Optional, search for visitors with a matching marital status

hasChildren

boolean | null

Optional, search for visitors with a matching parental status

residentStates

array of strings | null

Optional, search for visitors in matching states
Required values can be retrieved from the endpoint: /api/v1/reference/states.

residentStates

residentCities

array of strings | null

Optional, search for visitors in matching cities

residentCities

residentZipCodes

array of strings | null

Optional, search for visitors in matching zip codes

residentZipCodes

annualIncomeRanges

array of strings | null

Search for visitors within a matching annual income range
Required values can be retrieved from the endpoint: /api/v1/reference/annualIncomeRanges.

annualIncomeRanges

netWorthRanges

array of strings | null

Optional, search for visitors within a matching net worth range
Required values can be retrieved from the endpoint: /api/v1/reference/netWorthRanges.

netWorthRanges

isHomeOwner

boolean | null

Optional, search for visitors who own a home

domains

array of strings | null

Optional, search for visitor who visited a site with a matching domain

domains

referralSources

array of strings | null

Optional, search for visitors who came from matching referral sources

referralSources

keywords

array of strings | null

Optional, search for visitors with matching keywords in their searches

keywords

ipAddresses

array of strings | null

Optional, search for visitors from matching IP addresses

ipAddresses

pageViewed

string | null

Optional, search for visitors who viewed a matching page

jobName

string

The name of the bulk lead job.

Headers

X-Version

string | null

Responses

500

200Task completed returns the created jobId.

400

401

403

404

429