> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Update schedule

PUT https://api.runtype.com/v1/products/{id}/surfaces/{surfaceId}/schedules/{scheduleId}
Content-Type: application/json

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

Reference: https://docs.runtype.com/api-reference/runtype-api/products/update-schedule

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Path parameters

- `id` (string, required)
- `surfaceId` (string, required)
- `scheduleId` (string, required)

### Body (application/json)

This endpoint expects an object.

- `cron` (string, optional, nullable)
- `enabled` (boolean, optional)
- `executionOptions` (V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaExecutionOptions, optional)
- `flowId` (string, optional)
- `recordFilter` (V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilter, optional, nullable)
- `recordIds` (list of string, optional)
- `recordType` (string, optional, nullable)
- `runAt` (datetime, optional, nullable)
- `timezone` (string, optional, nullable)
- `triggerType` (enum, optional)
  - Allowed values: `one_time`, `recurring`

## Response

### 200

Schedule updated

- `agentId` (string, required, nullable)
- `createdAt` (string, required)
- `cron` (string, required, nullable)
- `enabled` (boolean, required)
- `executionOptions` (map from string to any, required)
- `flowId` (string, required, nullable)
- `id` (string, required)
- `inputs` (map from string to any, required, nullable)
- `lastRunAt` (string, required, nullable)
- `name` (string, required, nullable)
- `nextRunAt` (string, required, nullable)
- `organizationId` (string, required, nullable)
- `productSurfaceId` (string, required, nullable)
- `recordIds` (list of string, required, nullable)
- `recordType` (string, required, nullable)
- `runAt` (string, required, nullable)
- `timezone` (string, required, nullable)
- `triggerType` (string, required)
- `updatedAt` (string, required)
- `userId` (string, required)
- `messages` (any, optional)
- `recordFilter` (any, optional)

## Errors

### 400 Bad Request Error

Validation error, or RUNTIME_LANE_INELIGIBLE for a flow the batch host cannot run

- `error` (string, required)
- `code` (string, optional) — Stable error code. SCHEDULE_AGENT_CONFIG_UNSUPPORTED: the target agent uses config a schedule cannot supply; `details[].path` names it. RUNTIME_LANE_INELIGIBLE: the target flow uses capabilities the batch host cannot run; `reasons` names them.
- `details` (list of ScheduleValidationErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.
- `message` (string, optional) — Human-readable error message.
- `reasons` (list of string, optional) — With RUNTIME_LANE_INELIGIBLE: stable `ineligible:*` reason codes, e.g. `ineligible:wait-until`.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Product, surface, or schedule not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaExecutionOptions

- `chunkSize` (integer, optional)
- `flowTimeoutMs` (integer, optional)
- `loggingPolicy` (enum, optional)
  - Allowed values: `default`, `on`, `off`
- `maxRetries` (integer, optional)
- `modelOverride` (string, optional)
- `progressFlushSize` (integer, optional)
- `recordConcurrency` (integer, optional)
- `skipCacheWarm` (boolean, optional)
- `stepTimeoutMs` (integer, optional)
- `timeoutMs` (integer, optional)

### V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilter

- `type` (string, required)
- `where` (V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilterWhere, optional)

### ScheduleValidationErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilterWhere

- RecordFilterCondition: RecordFilterCondition
- V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilterWhere1

### RecordFilterCondition

- `field` (string, required)
- `op` (enum, required)
  - Allowed values: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `between`, `contains`, `startsWith`, `endsWith`, `in`, `notIn`, `isSet`, `isNotSet`, `isTrue`, `isFalse`, `withinLastDays`, `olderThanDays`
- `value` (any, optional)

### V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilterWhere1

- `conditions` (list of V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilterWhereOneOf1ConditionsItems, required)
- `op` (enum, required)
  - Allowed values: `and`, `or`

### V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilterWhereOneOf1ConditionsItems

- RecordFilterCondition: RecordFilterCondition
- V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilterWhereOneOf1ConditionsItems1

### V1ProductsIdSurfacesSurfaceIdSchedulesScheduleIdPutRequestBodyContentApplicationJsonSchemaRecordFilterWhereOneOf1ConditionsItems1

- `conditions` (list of RecordFilterCondition, required)
- `op` (enum, required)
  - Allowed values: `and`, `or`

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "agentId": "string",
  "createdAt": "string",
  "cron": "string",
  "enabled": true,
  "executionOptions": {},
  "flowId": "string",
  "id": "string",
  "inputs": {},
  "lastRunAt": "string",
  "name": "string",
  "nextRunAt": "string",
  "organizationId": "string",
  "productSurfaceId": "string",
  "recordIds": [
    "string"
  ],
  "recordType": "string",
  "runAt": "string",
  "timezone": "string",
  "triggerType": "string",
  "updatedAt": "string",
  "userId": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```