Skip to main content
POST
Run Workflow

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Headers

Idempotency-Key
string | null
Required string length: 1 - 255

Path Parameters

workflow_id
string<uuid>
required

Body

application/json
input
Input · object[] | null

Rows to run the workflow on, one object per row. Only for workflows whose first block is Incoming Webhooks.

Minimum array length: 1
source_overrides
Source Overrides · object | null

Settings to change on the first block for this run only. A Read CSV source requires resource_handle_id: pass the file_id returned by POST /v1/files unchanged, or a raw resource UUID. Other settings use the saved values when omitted.

result_formats
string[] | null

File formats to save results in, such as csv or ndjson. Default: csv.

Maximum array length: 4
Maximum string length: 200
revision
integer | null

Run only if the workflow's revision still equals this value. Otherwise the run is refused with 409.

Required range: x >= 0
wait_seconds
integer
default:0

Seconds to wait for the Job to finish before responding. Default: 0. Range: 0 to 20.

Required range: 0 <= x <= 20

Response

Job finished within the wait window.

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

Current Job status. Stop polling on succeeded, failed or canceled.

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

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

operation
enum<string>
required

Action performed by the Job.

Available options:
people.search,
companies.search,
people.contacts,
people.contacts.reverse,
people.intelligence,
companies.intelligence,
lists.create,
exports.create,
workflows.run,
qa-agent.run,
verify-age.run
next_poll_after
integer | null

Seconds before the next poll. Present only while the Job is queued or running.

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.

counts
JobCounts · object | null

Input record counts, when available.

charge_credits
number | null

Net credits captured at retrieval, including refunds. May change after the Job finishes; null when unavailable, unknown, or withheld by spend permissions.