v1

latestOpenAPI 3.0.3MIT2026-07-1411163326.7 KB

Schedule

Create a schedule

Creates a schedule and returns the created schedule. Available only on organizations of type bitbucket and github, and for the latter will exclusively create schedule triggers associated with the GitHub OAuth pipeline definition. For projects of type circleci, or to create schedule triggers for GitHub App pipeline definitions, use the Create trigger endpoint.

post/project/{project-slug}/schedule

Path parameters

project-slugstring required

Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

Request body

namestring required

Name of the schedule.

attribution-actor'current' | 'system' required

The attribution-actor of the scheduled pipeline.

parametersobject required

Pipeline parameters represented as key-value pairs. Must contain branch or tag.

descriptionstring

Description of the schedule.

Example request

{
  "attribution-actor": "current",
  "parameters": {
    "deploy_prod": true,
    "branch": "feature/design-new-api"
  }
}

Response

A schedule object.

idstring uuid required

The unique ID of the schedule.

updated-atstring date-time required

The date and time the pipeline was last updated.

namestring required

Name of the schedule.

created-atstring date-time required

The date and time the pipeline was created.

project-slugstring required

The project-slug for the schedule

parametersobject required

Pipeline parameters represented as key-value pairs. Must contain branch or tag.

descriptionstring required

Description of the schedule.

Example response

{
  "project-slug": "gh/CircleCI-Public/api-preview-docs",
  "parameters": {
    "deploy_prod": true,
    "branch": "feature/design-new-api"
  }
}