Skip to main content
POST
Start Bulk People

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Headers

Idempotency-Key
string | null
  • Scoped to organization + operation.
  • Same key + body: same job, no new charge, Idempotent-Replayed: true.
  • Different body: 409 idempotency_key_reused.
  • Uploads must match filename + contents.
  • Omit for no replay protection.
  • JSON replay lasts through the workflow retention window; CSV replay lasts 24 hours.
Required string length: 1 - 255

Body

multipart/form-data
file
file
required
config
string
required
Maximum string length: 1000000

Response

Successful Response

job_id
string
required

Job identifier, normally prefixed with job_. Store it exactly as returned. GET /v1/jobs/{job_id} also accepts IDs returned by unversioned endpoints.

status
enum<string>
required

queued: accepted and waiting to start. running: work is in progress. succeeded: work finished successfully. failed: work ended with an error. canceled: work was canceled. The last three states are terminal; stop polling.

Available options:
queued,
running,
succeeded,
failed,
canceled
created_at
string<date-time>
required

UTC timestamp when the job was created, in ISO 8601 format.

next_poll_after
integer | null

Seconds before polling again while queued or running; omitted for terminal states.

progress
Progress · object | null

Operation-specific progress while queued or running; omitted when unavailable.

result
any

Successful output when available; bulk jobs may return download links.

error
JobError · object | null

Failure details when available; omitted otherwise.