Skip to main content
POST
https://api.clay.com/public/v0
/
routines
/
{routine_id}
/
run-batch
/
start
Start an async routine run-batch over an uploaded JSONL file
curl --request POST \
  --url https://api.clay.com/public/v0/routines/{routine_id}/run-batch/start \
  --header 'Content-Type: application/json' \
  --header 'clay-api-key: <api-key>' \
  --data '
{
  "file_id": "<string>"
}
'
{
  "routine_run_id": "<string>",
  "status": "<string>"
}

Authorizations

​
clay-api-key
string
header
required

Personal API key tied to your Clay user. Create one under Settings → Account in the Clay app.

Path Parameters

​
routine_id
string
required

Body

application/json

Body

​
file_id
string
required
​
webhook_id
string

ID of a registered Clay webhook to notify when the run finishes.

Required string length: 1 - 64

Response

202

​
routine_run_id
string
required
​
status
string
required
Allowed value: "in_progress"