v1

latestOpenAPI 3.0.02026-07-136452257.6 KB

Create import schedule

Creates a new scheduled import configuration for the specified import source. Scheduled imports allow you to automate data imports on a recurring basis (daily, weekly, monthly) or run them once at a specific time.

post/importsource/{importSourceId}/importschedule

Path parameters

importSourceIdstring required

The ID of the import source to schedule

Request body

startTimestring date-time required

The date and time when the first import should execute, in ISO 8601 format (e.g., '2024-01-15T02:00:00Z'). Must be in the future.

runInterval'ONCE' | 'DAILY' | 'WEEKLY' | 'MONTHLY' required

The frequency of the scheduled import. ONCE: runs only at startTime. DAILY: runs every day at the specified time. WEEKLY: runs every 7 days. MONTHLY: runs on the same day of each month.

callbackUrlstring uri nullable

Optional webhook URL to call after each scheduled import execution. The URL will receive a POST request with execution status.

Example request

{
  "startTime": "2024-01-15T02:00:00Z",
  "runInterval": "DAILY",
  "callbackUrl": "https://example.com/webhook/import-complete"
}

Response

Import schedule created successfully

idstring

The unique identifier of the import schedule

importSourceIdstring

The ID of the associated import source

startTimestring date-time

The start time of the schedule in ISO 8601 format

runInterval'ONCE' | 'DAILY' | 'WEEKLY' | 'MONTHLY'

The frequency of the scheduled import

createdstring date-time

Timestamp when the schedule was created

updatedstring date-time

Timestamp when the schedule was last updated

collectionIdstring

The collection (object schema) ID associated with this import

Example response

{
  "id": "a8f5f167-a7e1-4b3a-9e4f-2c3d4e5f6a7b",
  "importSourceId": "b9f5f167-a7e1-4b3a-9e4f-2c3d4e5f6a7c",
  "startTime": "2024-01-15T02:00:00Z",
  "runInterval": "DAILY",
  "created": "2024-01-10T10:30:00Z",
  "updated": "2024-01-12T14:45:00Z",
  "collectionId": "c7d8e9f0-1234-5678-9abc-def012345678"
}