Skip to main content
POST
/
v1
/
waterfalls
/
{waterfall_identifier}
/
bulk-run
curl --request POST \
  --url https://api.databar.ai/v1/waterfalls/{waterfall_identifier}/bulk-run \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <x-apikey>' \
  --data '
{
  "params": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "company": "example.com"
    },
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "company": "test.org"
    }
  ],
  "enrichments": [
    833,
    966
  ],
  "email_verifier": 10
}
'
{
  "task_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "created"
}
{
  "detail": [
    {
      "param1": [
        "This field is required."
      ]
    }
  ]
}
{
  "detail": "Forbidden"
}
{
  "detail": "Check the number of remaining credits or the tariff plan."
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
This endpoint is asynchronous. It returns a task_id — poll Get task status to retrieve your results. Task data expires after 24 hours.
Results are aligned to your inputs: the data array has one element per input, in the same order you submitted them, with null for inputs that returned no data. So len(data) equals the number of inputs and data[i] is the result for input i — join results back to inputs by position.

Headers

​
x-apikey
any
required

API Key for authentication

Path Parameters

​
waterfall_identifier
string
required

The identifier of the waterfall to run

Body

application/json
​
params
Params · object[]
required
​
enrichments
integer[]
required

Select at least 1 enrichment

Minimum array length: 1
​
email_verifier
integer | null

Response

Successfully submitted the bulk waterfall run

​
task_id
string
required
​
status
string
required