Skip to content
UltimateTeam.ai Docs

Create Schedule

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

Create a schedule for a workflow template.

Validates that the template exists, then stores the schedule configuration. Does not create an actual Cloud Scheduler job (that is an infrastructure concern).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateScheduleRequest

Request body for creating a template schedule.

Attributes: template_id: The template to schedule. cron_expression: Cron expression for the schedule. params: Parameters to pass on each execution. enabled: Whether the schedule is active.

object
cron_expression
required
Cron Expression
string
enabled
Enabled
boolean
default: true
params
Params
object
key
additional properties
any
template_id
required
Template Id
string

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
Response Create Schedule Api V1 Workflows Schedules Post
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"
    }
  ]
}