---
title: "Schedule a Playbook Run"
method: POST
path: "/v2.0/playbooks/{playbookId}/schedule"
tags: ["Playbooks"]
---

# Schedule a Playbook Run

`POST /v2.0/playbooks/{playbookId}/schedule`

Schedules a Playbook run.

## Path parameters

- `playbookId` string, required

## Headers

- `Accept` 'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

## Request body

- object
  - `entrypoint` string — The unique identifier for the Snapshot or Project used for the Playbook run.
  - `flowId` string — The Flow ID for the Playbook run.
  - `localeId` string — The Locale ID for the Playbook run.

## Response `200`

Playbook run successfully scheduled.

- object — Created task metadata (same shape as ITaskReturnValue).
  - `_id` string
  - `status` string — Task status (e.g. queued, active, done)
  - `type` string — Task type (e.g. runPlaybook)
  - `parameters` object — Task payload (playbookId, projectId, entrypoint, flowId, localeId, etc.)
  - `createdAt` number — Unix timestamp in seconds when the task was created
  - `lastChangedAt` number — Unix timestamp in seconds when the task was last updated
  - `progress` integer — Task progress (0-100)
  - `job` object — Present only when the task runs as a Kubernetes job
    - `name` string
    - `namespace` string
    - `timeoutInMs` number

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)
- `401` — The request has not been applied because it lacks valid authentication credentials for the target resource.
- `402` — Upgrade your Plan to increase your Quota.
- `403` — The server understood the request but refuses to authorize it.
- `404` — The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
- `405` — The method received in the request-line is known by the origin server but not supported by the target resource.
- `409` — The request conflicts with current state of the server.
- `413` — The request entity is larger than limits defined by server.
- `500` — The server encountered an unexpected condition that prevented it from fulfilling the request.
- `501` — The server does not support the functionality required to fulfill the request.
- `502` — The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
- `503` — The server is not ready to handle the request.
- `504` — The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.

---

[API](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) · [All operations](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cognigy/simulator-openapi-rest-ful-api-reference/revisions/85b2872bdfb7/schema)