Skip to main content
POST
/
v1
/
actions
curl --request POST \
  --url https://openapi.enginy.ai/v1/actions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "actions": [
    {
      "type": "VERIFY_LEAD_EMAIL"
    }
  ],
  "contactIds": [
    123,
    456
  ],
  "webhookUrl": "https://your-domain.com/webhooks/enginy"
}
'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "actionsId": 123,
    "createdAt": "2023-12-25"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Provide exactly one of contactIds, companyIds, contactGroupIds, or companyGroupIds to choose the target set.

​
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 by name · object | Scrape company Account IQ from LinkedIn · 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)[]
required

Array of actions to execute

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