Create schedule for surface | Runtype Documentation

curl -X POST https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "flowId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "triggerType": "one_time"
}'

{
  "agentId": "agent-9876543210",
  "createdAt": "2024-06-01T09:00:00Z",
  "cron": "null",
  "enabled": true,
  "executionOptions": {},
  "flowId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "id": "schedule-1234567890",
  "inputs": {},
  "lastRunAt": "null",
  "name": "Monthly Data Sync",
  "nextRunAt": "2024-07-01T09:00:00Z",
  "organizationId": "org-1122334455",
  "productSurfaceId": "surface-5566778899",
  "recordIds": [
    "record-001",
    "record-002"
  ],
  "recordType": "user_data",
  "runAt": "2024-07-01T09:00:00Z",
  "timezone": "America/New_York",
  "triggerType": "one_time",
  "updatedAt": "2024-06-01T09:00:00Z",
  "userId": "user-9988776655"
}

Create a new schedule (one-time or recurring) for a schedule-type surface.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

surfaceIdstringRequired

Request

This endpoint expects an object.

flowIdstringRequired

triggerTypeenumRequired

Allowed values:

cronstringOptional

enabledbooleanOptional

executionOptionsobjectOptional

recordFilterobjectOptional

recordIdslist of stringsOptional

recordTypestringOptional>=1 character

runAtdatetimeOptional

timezonestringOptional

Response

Schedule created

agentIdstring or null

createdAtstring

cronstring or null

enabledboolean

executionOptionsmap from strings to any

flowIdstring or null

idstring

inputsmap from strings to any or null

lastRunAtstring or null

namestring or null

nextRunAtstring or null

organizationIdstring or null

productSurfaceIdstring or null

recordIdslist of strings or null

recordTypestring or null

runAtstring or null

timezonestring or null

triggerTypestring

updatedAtstring

userIdstring

messagesany

recordFilterany

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error