Overview
The Actions API allows you to programmatically execute enrichments and other actions on your contacts and companies. This endpoint enables you to automate complex data enrichment pipelines by chaining multiple actions together in a single request. An “actions run” is a concatenated series of actions that executes one or more enrichments on a set of contacts or companies. Each action runs sequentially on each entity.Request Body
The request must include aactions array and one of the following target specifiers:
| Field | Type | Description |
|---|---|---|
contactIds | number[] | Array of contact IDs to process |
companyIds | number[] | Array of company IDs to process |
contactGroupIds | number[] | Array of contact list IDs to process |
companyGroupIds | number[] | Array of company list IDs to process |
| Field | Type | Description |
|---|---|---|
type | ActionType | The type of action to execute (see Available actions below) |
options | custom object | Configuration options specific to the action type (optional) |
Available Actions
Get contact from LinkedIn
Scrapes complete profile information from LinkedIn. Type:SCRAPE_LEAD_FROM_LINKEDIN
Options:
Enrich with email
Finds professional email addresses for contacts. Type:ENRICH_WITH_EMAIL
Options:
VERIFY_LEAD_EMAIL for best results
Enrich with phone
Finds phone numbers for contacts. Type:ENRICH_WITH_PHONE
Options:
Verify contact email addresses
Verifies email addresses for deliverability. Type:VERIFY_LEAD_EMAIL
Options: None required
Use When: You have email addresses and want to verify they’re valid before sending
Best Practice: Always verify emails before running email campaigns
Verify contact phone number
Verifies phone numbers for validity. Type:VERIFY_LEAD_PHONE
Options: None required
Use When: You have phone numbers and want to verify they’re valid
Export to CRM
Exports enriched contact or company data to your connected CRM. Type:EXPORT_TO_CRM
Options: