Run schedule immediately | Runtype Documentation

Trigger an immediate batch run of a schedule, resolving its records and submitting a batch.

AuthorizationBearer

API key or Clerk session token

idstringRequired

surfaceIdstringRequired

scheduleIdstringRequired

Schedule run queued

batchExecutionIdstring

recordCountinteger

statusstring

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId/run-now \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

$	curl -X POST https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId/run-now \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"batchExecutionId": "a3f47b9e-8c2d-4f1a-9b7e-2d5f3c6a1e4b",
3	"recordCount": 125,
4	"status": "queued"
5	}