Schedules

Restore schedule

Changed on

Restore a schedule out of the trash. It runs on its schedule again, unless it was paused before it was deleted or Omni disabled it. For example, because its Slack or Google Sheets account was disconnected.

Calling this endpoint on a schedule that isn't in the trash is safe. It returns 200 and leaves the schedule as it was, unless it can't be restored for one of the reasons below.

post/v1/schedules/{scheduleId}/restore

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/schedules/{scheduleId}/restore
  • Auth
    HTTP bearer

Path parameters

scheduleIdstring uuid required

The ID of the schedule. To find a schedule's ID:

  1. Navigate to the dashboard or workbook.
  2. Click File > Deliveries & Alerts.
  3. Next to a schedule, click Edit.

The schedule's ID is in the page's URL, after /schedules/. For example, the schedule ID in this URL is 123e4567-e89b-12d3-a456-426614174000:

https://blobsrus.omniapp.co/dashboards/e23ebaa0/schedules/123e4567-e89b-12d3-a456-426614174000

Response

Schedule restored, or it wasn't in the trash and was left as it was

successboolean

Example response

{
  "success": true
}

Changes