Skip to content

Create Batch Enrichment

Request

Create a batch enrichment job by uploading a CSV.

How it works

  1. Upload a .csv file (one column: handle or email)
  2. Choose the enrichment mode (handle: raw/full, email: basic)
  3. Use the returned batch_id to check status and download results

Request

  • multipart/form-data
  • file: CSV (max 10MB)
  • Mode fields depend on whether you’re enriching by handle or email

Credits

  • Credits are deducted per successfully enriched record
  • The credit rate follows the corresponding single-enrichment pricing (handle raw/full, or email enrichment)
  • If no data is returned for a record, 0 credits are deducted for that record

Checking completion

Poll GET /public/v1/enrichment/batch/{batch_id}/status/ every 30–60 seconds until the job finishes. Status values:

  • queued — waiting to start
  • processing — actively enriching records
  • finished — all records done; download results via GET /public/v1/enrichment/batch/{batch_id}/
  • failed — job failed
  • paused_insufficient_credits — top up credits and call the resume endpoint

This API is polling-based. There are no webhooks or push notifications.

Security
Bearer
Bodymultipart/form-datarequired
filestring, (binary)required

CSV file containing creators to enrich (max 10MB, single column: handle or email)

Example:"(binary)"
platformstring

Social media platform (required for handle-based enrichment)

Enum:"instagram""youtube""tiktok""twitter""twitch""onlyfans"
Example:"instagram"
enrichment_modestringrequired

Enrichment mode: 'raw' or 'full' for handle-based, 'basic' or 'advanced' for email-based

Enum:"raw""full""basic"
Example:"full"
metadataobject or null

Optional metadata as JSON object (e.g., {"campaign": "Q4 Outreach"})

Example:
{
  "campaign": "Q4 Outreach"
}
email_requiredstring

Email requirement for handle-based full enrichment. Default: "preferred"

Enum:"must_have""preferred"
Example:"preferred"
include_lookalikesboolean

Include lookalike creators for handle-based full enrichment. Default: false

Default:false
Example:false
include_audience_databoolean

Include audience data for handle-based full enrichment. Default: true

Default:true
Example:true
exclude_platformsstring

Platforms to exclude from response

Enum:"instagram""youtube""tiktok""twitter""twitch""onlyfans"
Example:"twitter"
min_followersinteger
Example:1000
POST
/public/v1/enrichment/batch/
curl -i -X POST \
  https://api-dashboard.influencers.club/public/v1/enrichment/batch/ \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=(binary)' \
  -F platform=instagram \
  -F enrichment_mode=full \
  -F 'metadata={"campaign":"Q4 Outreach"}' \
  -F email_required=preferred \
  -F include_lookalikes=false \
  -F include_audience_data=true \
  -F exclude_platforms=twitter \
  -F min_followers=1000

Responses

Bodyapplication/json
batch_idstringrequired

Unique identifier for the batch enrichment job

statusstringrequired

Current status of the batch job (processing, finished, failed, validating)

created_atstring, (date-time)required

Timestamp when the batch was created

platformstring or null

Platform used for enrichment (for handle-based enrichment)

metadataobject or null

Metadata provided with the batch

og_input_numberintegerrequired

Total number of records in the input file

type_reportstringrequired

Type of enrichment: ENRICH_BY_HANDLE or ENRICH_BY_EMAIL

enrichment_modestring or null

Enrichment mode: raw, full, basic

messagestringrequired

Human-readable message about the batch status

Response
{
  "batch_id": "string",
  "status": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "platform": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "og_input_number": 0,
  "type_report": "string",
  "enrichment_mode": "string",
  "message": "string"
}