Update schedule | Runtype Documentation

curl -X PUT https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "name": "Weekly Data Sync",
  "flowId": "flow-1234abcd",
  "productSurfaceId": "surface-5678efgh",
  "recordIds": [
    "record-001",
    "record-002",
    "record-003"
  ],
  "recordType": "user_activity",
  "triggerType": "recurring",
  "runAt": "2024-07-01T09:00:00Z",
  "cron": "0 9 * * 1",
  "timezone": "America/New_York",
  "enabled": true,
  "nextRunAt": "2024-07-08T09:00:00Z",
  "lastRunAt": "2024-06-24T09:00:00Z",
  "executionOptions": {},
  "createdAt": "2024-01-15T12:00:00Z",
  "updatedAt": "2024-06-20T15:30:00Z",
  "recordFilter": null
}

Update an existing schedule. Recomputes next run time when trigger settings change.

curl -X PUT https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "name": "Weekly Data Sync",
  "flowId": "flow-1234abcd",
  "productSurfaceId": "surface-5678efgh",
  "recordIds": [
    "record-001",
    "record-002",
    "record-003"
  ],
  "recordType": "user_activity",
  "triggerType": "recurring",
  "runAt": "2024-07-01T09:00:00Z",
  "cron": "0 9 * * 1",
  "timezone": "America/New_York",
  "enabled": true,
  "nextRunAt": "2024-07-08T09:00:00Z",
  "lastRunAt": "2024-06-24T09:00:00Z",
  "executionOptions": {},
  "createdAt": "2024-01-15T12:00:00Z",
  "updatedAt": "2024-06-20T15:30:00Z",
  "recordFilter": null
}

Update an existing schedule. Recomputes next run time when trigger settings change.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

surfaceIdstringRequired

scheduleIdstringRequired

Request

This endpoint expects an object.

flowIdstringOptional

recordIdslist of stringsOptional

recordTypestring or nullOptional>=1 character

recordFilterobject or nullOptional

triggerTypeenumOptional

Allowed values:

runAtdatetime or nullOptional

cronstring or nullOptional

timezonestring or nullOptional

enabledbooleanOptional

executionOptionsobjectOptional

Response

Schedule updated

idstring

namestring or null

flowIdstring or null

productSurfaceIdstring or null

recordIdslist of strings or null

recordTypestring or null

triggerTypestring

runAtstring or null

cronstring or null

timezonestring or null

enabledboolean

nextRunAtstring or null

lastRunAtstring or null

executionOptionsmap from strings to any

createdAtstring

updatedAtstring

recordFilterany or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

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

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"name": "Weekly Data Sync",
4	"flowId": "flow-1234abcd",
5	"productSurfaceId": "surface-5678efgh",
6	"recordIds": [
7	"record-001",
8	"record-002",
9	"record-003"
10	],
11	"recordType": "user_activity",
12	"triggerType": "recurring",
13	"runAt": "2024-07-01T09:00:00Z",
14	"cron": "0 9 * * 1",
15	"timezone": "America/New_York",
16	"enabled": true,
17	"nextRunAt": "2024-07-08T09:00:00Z",
18	"lastRunAt": "2024-06-24T09:00:00Z",
19	"executionOptions": {},
20	"createdAt": "2024-01-15T12:00:00Z",
21	"updatedAt": "2024-06-20T15:30:00Z",
22	"recordFilter": null
23	}