---
title: "Schedule Sync"
method: POST
path: "/api/schedule_sync"
tags: ["Scheduling"]
---

# Schedule Sync

`POST /api/schedule_sync`

## Request

- Base URL: `https://app.getdot.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://app.getdot.ai/api/schedule_sync`
- Auth: one of:
  - API key in header `X-API-KEY`
  - API key in cookie `Authorization`
  - OAuth 2 (password, token URL `/api/auth/token`)

Schedules a sync for a specific connection type and ID based on user-provided cron args.

Parameters:
- connection_type: The type of the connection (e.g., 'snowflake', 'bigquery').
- connection_id: The ID of the connection
- cron_args: The schedule for the sync (e.g., {"hour": 3, "minute": 0}).
- user: The current authenticated admin user.

## Request body

- SyncJobRequest
  - `connection_type` string, required
  - `connection_id` string, required
  - `cron_args` object, required
  - `refresh_samples` boolean

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getdot/apis/dot-api-2.md) · [All operations](https://skmtc.dev/getdot/apis/dot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/getdot/apis/dot-api-2/revisions/d26fe7163a7f?raw)