Skip to content
SupaCloud Docs
Select themeSelect language

put_api_schedules_id_

PUT
/api/schedules/{id}
curl --request PUT \
  --url https://example.com/api/schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie supacloud_session=<supacloud_session> \
  --data '{ "cadence": "example", "next_run_at": "2026-04-15T12:00:00Z", "status": "example", "timezone": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Schedule id

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
cadence
string | null
next_run_at
string | null format: date-time
status
string | null
timezone
string | null
Examplegenerated
{
  "cadence": "example",
  "next_run_at": "2026-04-15T12:00:00Z",
  "status": "example",
  "timezone": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
agent_profile_id
required

#708 F11 / who-5 — the agent PROFILE the fired task runs under (agent_profile_id WHO column). None = no pin. Surfaced so the schedule editor shows the current pin.

string | null format: uuid
agent_type
required
string
app_id
required

ADR 0030 W4 — when set, this schedule fires a kind='app' run of the given App on cadence. Exactly one of workflow_id / app_id / a task definition is set. Surfaced on the wire so the schedule-editor can show (and the trigger picker can filter on) the App target.

string | null format: uuid
app_inputs
required

ADR 0030 W4 — the per-fire App input payload prefilled into the run’s trigger context. None for a task / workflow schedule.

cadence
required
string
config
required
created_at
required
string format: date-time
failure_count
required
integer format: int32
id
required
string format: uuid
last_error
required
string | null
last_run_at
required
string | null format: date-time
last_run_id
required

The runs row of the schedule’s most recent fire (ADR 0022 R4). R5’s schedule-page run column links this into /runs/{last_run_id}; last_task_id (the task definition) is kept alongside it.

string | null format: uuid
last_task_id
required
string | null format: uuid
next_run_at
required
string | null format: date-time
project_id
required
string | null format: uuid
prompt
required
string
run_count
required
integer format: int32
status
required
string
timezone
required
string
title
required
string
updated_at
required
string format: date-time
user_id
required
string format: uuid
workflow_id
required

When set, this schedule fires a kind='workflow' run of the given workflow on cadence (ADR 0020 V4 schedule trigger). Exposed on the wire (V10) so the web builder’s schedule trigger config form can filter the schedules picker down to the rows that already belong to the workflow being edited, without a second round-trip.

string | null format: uuid
workspace_id
required
string format: uuid
Examplegenerated
{
  "agent_profile_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "agent_type": "example",
  "app_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "app_inputs": "example",
  "cadence": "example",
  "config": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "failure_count": 1,
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "last_error": "example",
  "last_run_at": "2026-04-15T12:00:00Z",
  "last_run_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "last_task_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "next_run_at": "2026-04-15T12:00:00Z",
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "prompt": "example",
  "run_count": 1,
  "status": "example",
  "timezone": "example",
  "title": "example",
  "updated_at": "2026-04-15T12:00:00Z",
  "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "workflow_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Section titled “400”

Structured client error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}