Import leads into a campaign

POST

/campaigns/{id}/imports

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

Campaign id.

Body

application/json

file_namestringrequired

Name the import is listed under.

Required string length: 1 - 120

csvstringrequired

The file's contents as CSV text, header row first.

Required string length: 1 - 5000000

mappingobjectrequired

Which column holds each lead field, by header; leave out a field no column holds.

custom_fieldsobject

Custom fields to keep, as field name to column header; templates use them as {@name|fallback}.

Response

application/json

Success

idstringrequired

Import id.

file_namestringrequired

The name the import was started with.

statusenum<string>required

running while rows are left, then done, or failed with the reason in failure.

Available options: running, done, failed

rowsintegerrequired

Rows in the file.

processedintegerrequired

Rows read so far.

addedintegerrequired

Leads added to the campaign.

creditsintegerrequired

Credits charged for the added leads.

skippedobjectrequired

Rows left out, counted by reason.

failurestring | nullrequired

Why the import stopped; null unless it failed.

started_atstringrequired

When the import started (ISO 8601).

finished_atstring | nullrequired

When it finished (ISO 8601); null while it runs.

Import leads into a campaign

curl --request POST \
  --url https://api.bavlio.com/campaigns/{id}/imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_name": "<string>",
  "csv": "<string>",
  "mapping": {
    "email": "<string>",
    "linkedin_url": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "full_name": "<string>",
    "title": "<string>",
    "company_name": "<string>",
    "company_domain": "<string>"
  },
  "custom_fields": {}
}
'

curl --request POST \  --url https://api.bavlio.com/campaigns/{id}/imports \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "file_name": "<string>",  "csv": "<string>",  "mapping": {    "email": "<string>",    "linkedin_url": "<string>",    "first_name": "<string>",    "last_name": "<string>",    "full_name": "<string>",    "title": "<string>",    "company_name": "<string>",    "company_domain": "<string>"  },  "custom_fields": {}}'

{
  "id": "<string>",
  "file_name": "<string>",
  "status": "running",
  "rows": 123,
  "processed": 123,
  "added": 123,
  "credits": 123,
  "skipped": {
    "no_name": 123,
    "no_email": 123,
    "no_linkedin": 123,
    "missing_details": 123,
    "opted_out": 123,
    "already_added": 123,
    "no_credits": 123
  },
  "failure": "<string>",
  "started_at": "<string>",
  "finished_at": "<string>"
}

{  "id": "<string>",  "file_name": "<string>",  "status": "running",  "rows": 123,  "processed": 123,  "added": 123,  "credits": 123,  "skipped": {    "no_name": 123,    "no_email": 123,    "no_linkedin": 123,    "missing_details": 123,    "opted_out": 123,    "already_added": 123,    "no_credits": 123  },  "failure": "<string>",  "started_at": "<string>",  "finished_at": "<string>"}