Skip to main content
POST
Upload Entity Ids

Description

The Upload Entity ID Dataset endpoint accepts a CSV of entity IDs and stores it as a reusable dataset. Use it when an async job’s input list is larger than you want to send inline, or when the same list feeds several jobs.
  • Input: Upload a CSV file of entity IDs as multipart/form-data, along with the entity type, a name, and a description.
  • Processing: The system stores the list and assigns it an identifier.
  • Output: A list_id you can reference when submitting an async job, plus metadata about the stored dataset.
  • Check rowCount after upload to confirm the whole file was ingested.
  • Mind expiresAt — datasets are not stored indefinitely; re-upload before running a job against an expired list.
  • Reuse one dataset across enrichments instead of uploading the same IDs repeatedly.
  • Keep async input within the 10,000-record limit per job.
See async jobs for how uploaded datasets feed into a job run.

Authorizations

api_key
string
header
required

Body

multipart/form-data
file
file
required

CSV file with entity IDs

entity_type
enum<string>
required

Entity type

Available options:
business,
prospect
name
string
required

Dataset name

description
string
required

Dataset description

Response

Successful Response

list_id
string
required
name
string
required
description
string
required
rowCount
integer
required
entityType
enum<string>
required
Available options:
business,
prospect
tenantId
string
required
expiresAt
string<date-time>
required