Sign in
workflows.schedules

Schedule Workflow

Schedule Workflow

post/v1/workflows/schedules

Request body

workflow_registration_idstring uuid nullable

The ID of the workflow registration to schedule

workflow_version_idstring uuid nullable

Deprecated: use workflow_registration_id

workflow_identifierstring nullable

The name or ID of the workflow to schedule

workflow_task_queuestring nullable

Deprecated. Use deployment_name instead.

schedule_idstring nullable

Allows you to specify a custom schedule ID. If not provided, a random ID will be generated.

deployment_namestring nullable

Name of the deployment to route this schedule to

Response

Successful Response

schedule_idstring required

The ID of the schedule

Changes

No recorded changes to this endpoint across all 3 revisions of this API.