Update schedule

veryfront__update_schedule

Requires project.runs.write.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug that owns the schedule.
schedule_idstringYesSchedule ID. Format: uuid.
namestringNoHuman-readable schedule name. Minimum length: 1. Maximum length: 255.
targetobjectNoTyped schedule target.
schedulestringNoSchedule expression, for example a cron expression. Minimum length: 1. Maximum length: 255.
timezonestringNoIANA timezone used to evaluate the schedule. Minimum length: 1. Maximum length: 128.
runtime_target_kindstringNoRuntime target kind for scheduled runs. Values: "main_branch", "environment", "preview_branch".
runtime_target_environment_idstring or nullNoEnvironment ID when runtime_target_kind is environment.
runtime_target_branch_idstring or nullNoBranch ID when runtime_target_kind is preview_branch.
configobjectNoRun configuration. For agent schedules, put the run prompt in config.prompt.
timeout_secondsintegerNoPer-run timeout in seconds.
backoff_limitintegerNoRetry backoff limit for failed scheduled runs. Minimum: 0.
concurrency_policystringNoHow overlapping scheduled runs are handled. Values: "Allow", "Forbid", "Replace".
max_runsinteger or nullNoOptional maximum number of scheduled runs.
statusstringNoUpdated schedule status. Values: "active", "paused".

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__update_schedule",
    "arguments": {
      "schedule_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
idstringYesSchedule ID. Format: uuid.
project_idstringYesOwning project ID. Format: uuid.
namestringYesHuman-readable schedule name.
statusstringYesSchedule status. Values: "active", "paused", "deleting".
paused_reasonstring or nullYesSystem pause reason when Veryfront pauses the schedule.
paused_atstring or nullYesTimestamp when Veryfront paused the schedule.
last_failure_atstring or nullYesTimestamp of the most recent schedule failure.
last_failure_codestring or nullYesMost recent schedule failure code.
last_failure_messagestring or nullYesMost recent schedule failure message.
last_failure_run_idstring or nullYesCanonical run ID for the most recent schedule failure.
targetobjectYesTyped schedule target.
schedulestringYesSchedule expression.
timezonestringYesIANA timezone.
runtime_target_kindstringYesRuntime target kind. Values: "main_branch", "environment", "preview_branch".
runtime_target_environment_idstring or nullYesEnvironment ID for environment schedules.
runtime_target_branch_idstring or nullYesBranch ID for preview branch schedules.
configobjectYesRun configuration without internal schedule target metadata.
timeout_secondsintegerYesPer-run timeout in seconds.
backoff_limitintegerYesRetry backoff limit.
concurrency_policystringYesHow overlapping scheduled runs are handled.
definition_sourcestringYesWhether the schedule is manually managed or source-defined. Values: "manual", "source".
source_trigger_idstring or nullYesSource trigger ID for source-defined schedules.
source_pathstring or nullYesSource file path for source-defined schedules.
source_hashstring or nullYesSource definition hash for source-defined schedules.
last_scheduled_atstring or nullYesLast scheduled fire time.
last_successful_atstring or nullYesLast successful run time.
healthobject or nullYesOptional staleness budget used for schedule health alerting.
max_runsinteger or nullYesOptional maximum run count.
run_countintegerYesFire reservations counted toward the repetition limit; released reservations are subtracted. Minimum: 0.
completed_atstring or nullYesCompletion time for finite schedules.
created_bystring or nullYesUser that created the schedule.
integration_requirementsobject[]NoOAuth scopes and exact provider resources required before the schedule can run. Default: [].
created_atstringYesCreation timestamp.
updated_atstringYesLast update timestamp.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug that owns the schedule."
    },
    "schedule_id": {
      "type": "string",
      "format": "uuid",
      "description": "Schedule ID."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Human-readable schedule name."
    },
    "target": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "task",
            "workflow",
            "agent"
          ],
          "description": "Kind of scheduled target."
        },
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Target identifier. For agent schedules, this is the agent ID."
        },
        "conversation_mode": {
          "type": "string",
          "enum": [
            "create_new",
            "existing",
            "none"
          ],
          "description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
        },
        "conversation_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid",
              "description": "Conversation identifier associated with the record."
            },
            {
              "type": "null",
              "description": "Conversation identifier that scopes the request."
            }
          ],
          "description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
        }
      },
      "required": [
        "kind",
        "id"
      ],
      "additionalProperties": false,
      "description": "Typed schedule target."
    },
    "schedule": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Schedule expression, for example a cron expression."
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "IANA timezone used to evaluate the schedule."
    },
    "runtime_target_kind": {
      "type": "string",
      "enum": [
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "Runtime target kind for scheduled runs."
    },
    "runtime_target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The runtime target environment id associated with this record."
        },
        {
          "type": "null",
          "description": "Provide the runtime target environment id."
        }
      ],
      "description": "Environment ID when runtime_target_kind is environment."
    },
    "runtime_target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The runtime target branch id associated with this record."
        },
        {
          "type": "null",
          "description": "Provide the runtime target branch id."
        }
      ],
      "description": "Branch ID when runtime_target_kind is preview_branch."
    },
    "config": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values associated with this result."
      },
      "description": "Run configuration. For agent schedules, put the run prompt in config.prompt."
    },
    "timeout_seconds": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "description": "Per-run timeout in seconds."
    },
    "backoff_limit": {
      "type": "integer",
      "minimum": 0,
      "description": "Retry backoff limit for failed scheduled runs."
    },
    "concurrency_policy": {
      "type": "string",
      "enum": [
        "Allow",
        "Forbid",
        "Replace"
      ],
      "description": "How overlapping scheduled runs are handled."
    },
    "max_runs": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "description": "The max runs associated with this record."
        },
        {
          "type": "null",
          "description": "Provide the max runs."
        }
      ],
      "description": "Optional maximum number of scheduled runs."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused"
      ],
      "description": "Updated schedule status."
    }
  },
  "required": [
    "schedule_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for updating a recurring project schedule.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Schedule ID."
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Owning project ID."
    },
    "name": {
      "type": "string",
      "description": "Human-readable schedule name."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused",
        "deleting"
      ],
      "description": "Schedule status."
    },
    "paused_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "System pause reason when Veryfront pauses the schedule."
    },
    "paused_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when Veryfront paused the schedule."
    },
    "last_failure_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp of the most recent schedule failure."
    },
    "last_failure_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Most recent schedule failure code."
    },
    "last_failure_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Most recent schedule failure message."
    },
    "last_failure_run_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The last failure run id associated with this record."
        },
        {
          "type": "null",
          "description": "The last failure run id returned by the tool."
        }
      ],
      "description": "Canonical run ID for the most recent schedule failure."
    },
    "target": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "task",
            "workflow",
            "agent"
          ],
          "description": "Kind of scheduled target."
        },
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "Target identifier. For agent schedules, this is the agent ID."
        },
        "conversation_mode": {
          "type": "string",
          "enum": [
            "create_new",
            "existing",
            "none"
          ],
          "description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
        },
        "conversation_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid",
              "description": "Conversation identifier associated with the record."
            },
            {
              "type": "null",
              "description": "Conversation identifier associated with this result."
            }
          ],
          "description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
        }
      },
      "required": [
        "kind",
        "id"
      ],
      "additionalProperties": false,
      "description": "Typed schedule target."
    },
    "schedule": {
      "type": "string",
      "description": "Schedule expression."
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone."
    },
    "runtime_target_kind": {
      "type": "string",
      "enum": [
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "Runtime target kind."
    },
    "runtime_target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The runtime target environment id associated with this record."
        },
        {
          "type": "null",
          "description": "The runtime target environment id returned by the tool."
        }
      ],
      "description": "Environment ID for environment schedules."
    },
    "runtime_target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The runtime target branch id associated with this record."
        },
        {
          "type": "null",
          "description": "The runtime target branch id returned by the tool."
        }
      ],
      "description": "Branch ID for preview branch schedules."
    },
    "config": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values associated with this result."
      },
      "description": "Run configuration without internal schedule target metadata."
    },
    "timeout_seconds": {
      "type": "integer",
      "description": "Per-run timeout in seconds."
    },
    "backoff_limit": {
      "type": "integer",
      "description": "Retry backoff limit."
    },
    "concurrency_policy": {
      "type": "string",
      "description": "How overlapping scheduled runs are handled."
    },
    "definition_source": {
      "type": "string",
      "enum": [
        "manual",
        "source"
      ],
      "description": "Whether the schedule is manually managed or source-defined."
    },
    "source_trigger_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Source trigger ID for source-defined schedules."
    },
    "source_path": {
      "type": [
        "string",
        "null"
      ],
      "description": "Source file path for source-defined schedules."
    },
    "source_hash": {
      "type": [
        "string",
        "null"
      ],
      "description": "Source definition hash for source-defined schedules."
    },
    "last_scheduled_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Last scheduled fire time."
    },
    "last_successful_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Last successful run time."
    },
    "health": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "maxStalenessSeconds": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991,
              "description": "The max staleness seconds associated with this record."
            }
          },
          "required": [
            "maxStalenessSeconds"
          ],
          "additionalProperties": false,
          "description": "Structured health details associated with this record."
        },
        {
          "type": "null",
          "description": "The health returned by the tool."
        }
      ],
      "description": "Optional staleness budget used for schedule health alerting."
    },
    "max_runs": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "description": "The max runs associated with this record."
        },
        {
          "type": "null",
          "description": "The max runs returned by the tool."
        }
      ],
      "description": "Optional maximum run count."
    },
    "run_count": {
      "type": "integer",
      "minimum": 0,
      "description": "Fire reservations counted toward the repetition limit; released reservations are subtracted."
    },
    "completed_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Completion time for finite schedules."
    },
    "created_by": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The created by associated with this record."
        },
        {
          "type": "null",
          "description": "The created by returned by the tool."
        }
      ],
      "description": "User that created the schedule."
    },
    "integration_requirements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "integration": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "pattern": "^[a-z0-9][a-z0-9_-]*$",
            "description": "The integration associated with this record."
          },
          "required_scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255,
              "description": "One required scope item associated with this record."
            },
            "maxItems": 50,
            "description": "The required scopes associated with this record.",
            "default": []
          },
          "resources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 64,
                  "pattern": "^[a-z][a-z0-9_-]*$",
                  "description": "The kind associated with this record."
                },
                "id": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 512,
                  "description": "Unique identifier for the record."
                },
                "parent": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "$ref": "#/properties/integration_requirements/items/properties/resources/items/properties/kind",
                      "description": "The kind returned by the tool."
                    },
                    "id": {
                      "$ref": "#/properties/integration_requirements/items/properties/resources/items/properties/id",
                      "description": "Unique identifier for the returned record."
                    }
                  },
                  "required": [
                    "kind",
                    "id"
                  ],
                  "additionalProperties": false,
                  "description": "The parent associated with this record."
                }
              },
              "required": [
                "kind",
                "id"
              ],
              "additionalProperties": false,
              "description": "One resource item associated with this record."
            },
            "maxItems": 50,
            "description": "The resources associated with this record.",
            "default": []
          }
        },
        "required": [
          "integration"
        ],
        "additionalProperties": false,
        "description": "One integration requirement item associated with this record."
      },
      "maxItems": 20,
      "description": "OAuth scopes and exact provider resources required before the schedule can run.",
      "default": []
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp."
    },
    "updated_at": {
      "type": "string",
      "description": "Last update timestamp."
    }
  },
  "required": [
    "id",
    "project_id",
    "name",
    "status",
    "paused_reason",
    "paused_at",
    "last_failure_at",
    "last_failure_code",
    "last_failure_message",
    "last_failure_run_id",
    "target",
    "schedule",
    "timezone",
    "runtime_target_kind",
    "runtime_target_environment_id",
    "runtime_target_branch_id",
    "config",
    "timeout_seconds",
    "backoff_limit",
    "concurrency_policy",
    "definition_source",
    "source_trigger_id",
    "source_path",
    "source_hash",
    "last_scheduled_at",
    "last_successful_at",
    "health",
    "max_runs",
    "run_count",
    "completed_at",
    "created_by",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "description": "Recurring project schedule.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}