---
title: "Create a scheduled task"
method: POST
path: "/scheduled-tasks"
tags: ["scheduled-tasks"]
---

# Create a scheduled task

`POST /scheduled-tasks`

## Request

- Base URL: `https://api.letsship.ai/v1`
- URL: `https://api.letsship.ai/v1/scheduled-tasks`
- Auth: none declared

## Request body

- CreateScheduledTaskRequest
  - `projectId` string, required
  - `name` string, required
  - `prompt` string, required
  - `triggers` ScheduledTaskTrigger[], required
    - `kind` 'schedule', required
    - `schedule` ScheduledTaskSchedule, required
      - `interval` 'daily' | 'weekly' | 'monthly', required
      - `time` string, required
      - `timezone` string, required
      - `weekday` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
      - `dayOfMonth` integer
  - `labels` string[]
  - `templateKey` string
  - `skipIfPreviousOpen` boolean
  - `enabled` boolean

## Response `200`

Created

- ScheduledTask
  - `createdByUserId` string, nullable
  - `id` string, required
  - `orgId` string, required
  - `projectId` string, required
  - `name` string, required
  - `prompt` string, required
  - `templateKey` string, nullable, required
  - `triggers` ScheduledTaskTrigger[], required
    - `kind` 'schedule', required
    - `schedule` ScheduledTaskSchedule, required
      - `interval` 'daily' | 'weekly' | 'monthly', required
      - `time` string, required
      - `timezone` string, required
      - `weekday` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
      - `dayOfMonth` integer
  - `labels` string[], required
  - `skipIfPreviousOpen` boolean, required
  - `enabled` boolean, required
  - `nextRunAt` integer, nullable, required
  - `lastRunAt` integer, nullable, required
  - `createdAt` integer, required
  - `updatedAt` integer, required

## Other responses

- `400`: Invalid
- `403`: Role insufficient
- `404`: Project not accessible

---

[API](https://skmtc.dev/letsship/apis/ship-api.md) · [All operations](https://skmtc.dev/letsship/apis/ship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/letsship/apis/ship-api/revisions/e6eac1bcadd4?raw)