Skip to main content
PUT
/
v1
/
connections
/
{connectionId}
/
schedules
/
{scheduleId}
Update schema refresh schedule
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/connections/{connectionId}/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schedule": "00 18 ? * * *",
  "timezone": "Europe/London",
  "hardRefresh": false
}
'
{
  "scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "connectionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "schedule": "00 18 ? * * *",
  "timezone": "Europe/London",
  "description": "At 06:00 PM GMT",
  "hardRefresh": false,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T11:00:00.000Z",
  "disabledAt": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
connectionId
string<uuid>
required

The unique identifier of the connection

​
scheduleId
string<uuid>
required

The unique identifier of the schema refresh schedule

Body

application/json
​
schedule
string
required

A 6-field cron expression in AWS EventBridge format defining when the schema refresh should run, specified as:

minute hour day-of-month month day-of-week year

For example:

  • 00 09 * * ? * - Every day at 9:00 AM
  • 00 18 ? * MON-FRI * - Every weekday at 6:00 PM
  • 30 08 1 * ? * - First day of every month at 8:30 AM
​
timezone
string
required

An IANA timezone identifier for when the schedule should run.

​
hardRefresh
boolean
default:false

Whether the scheduled refresh performs a hard refresh (removes dropped objects) or soft refresh (additive only). Defaults to false (soft refresh).

Response

Schema refresh schedule updated successfully

​
scheduleId
string<uuid>

The unique identifier of the schema refresh schedule

​
connectionId
string<uuid>

The unique identifier of the connection this schedule belongs to

​
schedule
string

A 6-field cron expression in AWS EventBridge format defining when the schema refresh should run.

Format: minute hour day-of-month month day-of-week year

​
timezone
string

The IANA timezone identifier for when the schedule should run

​
description
string

A human-readable description of the schedule, automatically generated from the cron expression and timezone

​
hardRefresh
boolean
default:false

Whether the scheduled refresh performs a hard refresh (removes dropped objects) or soft refresh (additive only). Defaults to false (soft refresh).

​
createdAt
string<date-time>

The timestamp when the schedule was created

​
updatedAt
string<date-time>

The timestamp when the schedule was last updated

​
disabledAt
string<date-time> | null

The timestamp when the schedule was disabled, or null if active