Need help? Get answers from the docs with Omni's in-app AI! Log in to your Omni instance and open the Omni Agent in the sidebar.
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"
}
'{
"scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"connectionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"schedule": "00 18 ? * * *",
"timezone": "Europe/London",
"description": "At 06:00 PM GMT",
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T11:00:00.000Z",
"disabledAt": null
}Update schema refresh schedule
Updates the schedule and/or timezone for an existing schema refresh schedule.
This endpoint requires Connection Admin permissions for the connection.
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"
}
'{
"scheduleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"connectionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"schedule": "00 18 ? * * *",
"timezone": "Europe/London",
"description": "At 06:00 PM GMT",
"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
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The unique identifier of the connection
The unique identifier of the schema refresh schedule
Body
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 yearFor example:
00 09 * * ? *- Every day at 9:00 AM00 18 ? * MON-FRI *- Every weekday at 6:00 PM30 08 1 * ? *- First day of every month at 8:30 AM
An IANA timezone identifier for when the schedule should run.
Response
Schema refresh schedule updated successfully
The unique identifier of the schema refresh schedule
The unique identifier of the connection this schedule belongs to
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
The IANA timezone identifier for when the schedule should run
A human-readable description of the schedule, automatically generated from the cron expression and timezone
The timestamp when the schedule was created
The timestamp when the schedule was last updated
The timestamp when the schedule was disabled, or null if active
Was this page helpful?