Skip to content
UltimateTeam.ai Docs

Update Schedule

PATCH
/api/v1/workflows/schedules/{schedule_id}
curl --request PATCH \
  --url https://api.ultimateteam.ai/api/v1/workflows/schedules/example \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "cron_expression": "example", "enabled": true, "params": {} }'

Partially update a schedule (toggle enabled, change cron).

Only non-None fields in the request body are applied. Returns 404 if the schedule does not exist or does not belong to the authenticated tenant.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
schedule_id
required
Schedule Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
UpdateScheduleRequest

Request body for partially updating a schedule.

All fields are optional – only provided fields are applied.

Attributes: enabled: New enabled state. cron_expression: New cron expression. params: New parameters dict.

object
cron_expression
Any of:
string
enabled
Any of:
boolean
params
Any of:
object
key
additional properties
any
Examplegenerated
{
  "cron_expression": "example",
  "enabled": true,
  "params": {}
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Update Schedule Api V1 Workflows Schedules Schedule Id Patch
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}