Skip to main content
POST

Authorizations

x-api-key
string
header
required

Body

application/json

Provide exactly one of contactIds, companyIds, contactGroupIds, or companyGroupIds to choose the target set. Use GET /v1/credits/pricing to inspect the current workspace credit costs before running billable actions.

actions
(Verify email · object | Verify phone · object | Scrape contact from LinkedIn · object | Find LinkedIn URL by name · object | Scrape company from LinkedIn · object | Find company LinkedIn URL · object | Scrape company Account IQ from LinkedIn · object | Get ecommerce data from StoreLeads · object | Enrich with email · object | Enrich with phone · object | Run contact AI variables · object | Run company AI variables · object | Search contacts from company · object | Export to CRM · object | Sync contacts with CRM · object | Sync companies with CRM · object)[]
required

Array of actions to execute. Each action type documents its required data, behavior, accepted options, and how to look up credit pricing.

Minimum array length: 1
contactIds
number[]

Array of contact IDs to run actions on

Minimum array length: 1
companyIds
number[]

Array of company IDs to run actions on

Minimum array length: 1
contactGroupIds
number[]

Array of contact list IDs to run actions on

Minimum array length: 1
companyGroupIds
number[]

Array of company list IDs to run actions on

Minimum array length: 1
webhookUrl
string<uri>

Optional webhook URL to receive notification when actions complete. Must be HTTPS in production.

Response

Actions run started successfully

status
enum<string>
required
Available options:
success
message
string
required
data
object
required