Update an Automation
curl --request PATCH \
--url https://api.checkfu.com/v1/automations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"expected_version": 123,
"name": "<string>",
"description": "<string>",
"external_id": "<unknown>",
"environment_id": "<unknown>",
"connected_runtime": "<string>",
"metadata": {},
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>",
"dedupe_key": "<unknown>",
"source": "<unknown>",
"filter": "<unknown>"
},
"ingest_secret": "<unknown>"
}
'import requests
url = "https://api.checkfu.com/v1/automations/{id}"
payload = {
"expected_version": 123,
"name": "<string>",
"description": "<string>",
"external_id": "<unknown>",
"environment_id": "<unknown>",
"connected_runtime": "<string>",
"metadata": {},
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>",
"dedupe_key": "<unknown>",
"source": "<unknown>",
"filter": "<unknown>"
},
"ingest_secret": "<unknown>"
}
headers = {
"checkfu-version": "<checkfu-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'checkfu-version': '<checkfu-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
expected_version: 123,
name: '<string>',
description: '<string>',
external_id: '<unknown>',
environment_id: '<unknown>',
connected_runtime: '<string>',
metadata: {},
trigger: {
kind: 'schedule',
cron: '<string>',
timezone: '<string>',
dedupe_key: '<unknown>',
source: '<unknown>',
filter: '<unknown>'
},
ingest_secret: '<unknown>'
})
};
fetch('https://api.checkfu.com/v1/automations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.checkfu.com/v1/automations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expected_version' => 123,
'name' => '<string>',
'description' => '<string>',
'external_id' => '<unknown>',
'environment_id' => '<unknown>',
'connected_runtime' => '<string>',
'metadata' => [
],
'trigger' => [
'kind' => 'schedule',
'cron' => '<string>',
'timezone' => '<string>',
'dedupe_key' => '<unknown>',
'source' => '<unknown>',
'filter' => '<unknown>'
],
'ingest_secret' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.checkfu.com/v1/automations/{id}"
payload := strings.NewReader("{\n \"expected_version\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"external_id\": \"<unknown>\",\n \"environment_id\": \"<unknown>\",\n \"connected_runtime\": \"<string>\",\n \"metadata\": {},\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dedupe_key\": \"<unknown>\",\n \"source\": \"<unknown>\",\n \"filter\": \"<unknown>\"\n },\n \"ingest_secret\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
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(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.checkfu.com/v1/automations/{id}")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_version\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"external_id\": \"<unknown>\",\n \"environment_id\": \"<unknown>\",\n \"connected_runtime\": \"<string>\",\n \"metadata\": {},\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dedupe_key\": \"<unknown>\",\n \"source\": \"<unknown>\",\n \"filter\": \"<unknown>\"\n },\n \"ingest_secret\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/automations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_version\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"external_id\": \"<unknown>\",\n \"environment_id\": \"<unknown>\",\n \"connected_runtime\": \"<string>\",\n \"metadata\": {},\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dedupe_key\": \"<unknown>\",\n \"source\": \"<unknown>\",\n \"filter\": \"<unknown>\"\n },\n \"ingest_secret\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspace_id": "<string>",
"version": 123,
"name": "<string>",
"description": "<string>",
"external_id": "<string>",
"created_by": "<string>",
"identity": {
"acted_as": "<string>"
},
"environment_id": "<string>",
"connected_runtime": "<string>",
"status": "active",
"paused_reason": {
"kind": "manual",
"error_type": "<unknown>"
},
"last_run_at": "<string>",
"last_session_id": "<string>",
"last_run_id": "<string>",
"next_run_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"target": {
"kind": "agent_definition",
"agent": {
"type": "agent",
"id": "<string>",
"version": 123
},
"session_target": {
"mode": "start_new"
},
"agent_deployment_id": "<unknown>",
"agent_deployment_revision_selection": "<unknown>",
"budget": {
"limit": 123,
"metric": "model_tokens"
}
},
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>",
"dedupe_key": "<unknown>",
"source": "<unknown>",
"filter": "<unknown>"
},
"input": {
"kind": "snapshot",
"prompt": "<string>",
"flow_review": {
"model_routing_profile_key": "<string>",
"criteria": [
{
"key": "<string>",
"description": "<string>",
"severity": "low"
}
],
"tier": "default"
},
"delivery_screen": {
"model_routing_profile_key": "<string>",
"instructions": "<string>",
"tier": "default",
"failure": "fail_open"
},
"resources": [
{
"kind": "file_tree",
"file_tree_id": "<string>",
"mount_path": "<string>",
"version_policy": {
"kind": "latest"
},
"access": "read_only",
"writeback": null
}
],
"prompt_template": "<unknown>"
},
"metadata": {}
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.not_found",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-not-found"
}
}{
"error": {
"type": "validation.conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}{
"error": {
"type": "memory.backend_unavailable",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#memory-backend-unavailable"
}
}Update an Automation
Update mutable configuration under optimistic versioning: expected_version must match the live version or the request conflicts.
PATCH
/
v1
/
automations
/
{id}
Update an Automation
curl --request PATCH \
--url https://api.checkfu.com/v1/automations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"expected_version": 123,
"name": "<string>",
"description": "<string>",
"external_id": "<unknown>",
"environment_id": "<unknown>",
"connected_runtime": "<string>",
"metadata": {},
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>",
"dedupe_key": "<unknown>",
"source": "<unknown>",
"filter": "<unknown>"
},
"ingest_secret": "<unknown>"
}
'import requests
url = "https://api.checkfu.com/v1/automations/{id}"
payload = {
"expected_version": 123,
"name": "<string>",
"description": "<string>",
"external_id": "<unknown>",
"environment_id": "<unknown>",
"connected_runtime": "<string>",
"metadata": {},
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>",
"dedupe_key": "<unknown>",
"source": "<unknown>",
"filter": "<unknown>"
},
"ingest_secret": "<unknown>"
}
headers = {
"checkfu-version": "<checkfu-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'checkfu-version': '<checkfu-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
expected_version: 123,
name: '<string>',
description: '<string>',
external_id: '<unknown>',
environment_id: '<unknown>',
connected_runtime: '<string>',
metadata: {},
trigger: {
kind: 'schedule',
cron: '<string>',
timezone: '<string>',
dedupe_key: '<unknown>',
source: '<unknown>',
filter: '<unknown>'
},
ingest_secret: '<unknown>'
})
};
fetch('https://api.checkfu.com/v1/automations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.checkfu.com/v1/automations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expected_version' => 123,
'name' => '<string>',
'description' => '<string>',
'external_id' => '<unknown>',
'environment_id' => '<unknown>',
'connected_runtime' => '<string>',
'metadata' => [
],
'trigger' => [
'kind' => 'schedule',
'cron' => '<string>',
'timezone' => '<string>',
'dedupe_key' => '<unknown>',
'source' => '<unknown>',
'filter' => '<unknown>'
],
'ingest_secret' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.checkfu.com/v1/automations/{id}"
payload := strings.NewReader("{\n \"expected_version\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"external_id\": \"<unknown>\",\n \"environment_id\": \"<unknown>\",\n \"connected_runtime\": \"<string>\",\n \"metadata\": {},\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dedupe_key\": \"<unknown>\",\n \"source\": \"<unknown>\",\n \"filter\": \"<unknown>\"\n },\n \"ingest_secret\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
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(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.checkfu.com/v1/automations/{id}")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_version\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"external_id\": \"<unknown>\",\n \"environment_id\": \"<unknown>\",\n \"connected_runtime\": \"<string>\",\n \"metadata\": {},\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dedupe_key\": \"<unknown>\",\n \"source\": \"<unknown>\",\n \"filter\": \"<unknown>\"\n },\n \"ingest_secret\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/automations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_version\": 123,\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"external_id\": \"<unknown>\",\n \"environment_id\": \"<unknown>\",\n \"connected_runtime\": \"<string>\",\n \"metadata\": {},\n \"trigger\": {\n \"kind\": \"schedule\",\n \"cron\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dedupe_key\": \"<unknown>\",\n \"source\": \"<unknown>\",\n \"filter\": \"<unknown>\"\n },\n \"ingest_secret\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspace_id": "<string>",
"version": 123,
"name": "<string>",
"description": "<string>",
"external_id": "<string>",
"created_by": "<string>",
"identity": {
"acted_as": "<string>"
},
"environment_id": "<string>",
"connected_runtime": "<string>",
"status": "active",
"paused_reason": {
"kind": "manual",
"error_type": "<unknown>"
},
"last_run_at": "<string>",
"last_session_id": "<string>",
"last_run_id": "<string>",
"next_run_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"target": {
"kind": "agent_definition",
"agent": {
"type": "agent",
"id": "<string>",
"version": 123
},
"session_target": {
"mode": "start_new"
},
"agent_deployment_id": "<unknown>",
"agent_deployment_revision_selection": "<unknown>",
"budget": {
"limit": 123,
"metric": "model_tokens"
}
},
"trigger": {
"kind": "schedule",
"cron": "<string>",
"timezone": "<string>",
"dedupe_key": "<unknown>",
"source": "<unknown>",
"filter": "<unknown>"
},
"input": {
"kind": "snapshot",
"prompt": "<string>",
"flow_review": {
"model_routing_profile_key": "<string>",
"criteria": [
{
"key": "<string>",
"description": "<string>",
"severity": "low"
}
],
"tier": "default"
},
"delivery_screen": {
"model_routing_profile_key": "<string>",
"instructions": "<string>",
"tier": "default",
"failure": "fail_open"
},
"resources": [
{
"kind": "file_tree",
"file_tree_id": "<string>",
"mount_path": "<string>",
"version_policy": {
"kind": "latest"
},
"access": "read_only",
"writeback": null
}
],
"prompt_template": "<unknown>"
},
"metadata": {}
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.not_found",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-not-found"
}
}{
"error": {
"type": "validation.conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}{
"error": {
"type": "memory.backend_unavailable",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#memory-backend-unavailable"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Available options:
2026-08-31 Path Parameters
Pattern:
^auto_[0-9a-f]{32}$Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Required string length:
1 - 255Required string length:
1 - 4096Show child attributes
Show child attributes
Pattern:
^crt_[0-9a-f]{32}$at most 16 correlation pairs with keys of 1 to 64 characters
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Automation
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Pattern:
^auto_[0-9a-f]{32}$Pattern:
^wrkspc_[0-9a-f]{32}$Required string length:
1 - 255Required string length:
1 - 4096Pattern:
^[a-z0-9](?:[a-z0-9._-]{0,93})$Pattern:
^prin_[0-9a-f]{32}$Show child attributes
Show child attributes
Pattern:
^env_[0-9a-f]{32}$Pattern:
^crt_[0-9a-f]{32}$Available options:
active, paused - Option 1
- Option 2
Show child attributes
Show child attributes
Pattern:
^sess_[0-9a-f]{32}$Pattern:
^run_[0-9a-f]{32}$Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
at most 16 correlation pairs with keys of 1 to 64 characters
Show child attributes
Show child attributes