API Reference

Create a bulk contact job.

post
https://api.visualvisitor.com/api/v1/whoToContact/bulkJob/create

Queried customer must have a +PlusEmployee plan enabled.
Minimal scope required: "customers.read".
After job is created, validate the credits required and then run BulkContactConfirmJob to confirm and process the job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string | null

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

string | null
Body Params

The JSON object containing the job instruction and search filter.

Represents the data to create a bulk contact job.

string

The name of the bulk contact job.

string | null

Optional, the tag names to used for grouping bulk contact jobs.

boolean

Only return saved contacts in the bulk contact job.

searchCriteria

The filter object defining the search criteria for the bulk contact job.

Headers
string | null
Responses

500

Updated over 1 year ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?