AI13

AI Credit Controls6

AI Credit Usage2

AI Eval12

AI Model Suggestions9

AI Routines6

API Tokens4

App downloads3

Apps8

Branches3

Color Palettes5

Connection environments3

Connections5

Content2

Content migration2

Content validator2

Dashboard downloads3

Dashboard filters2

dbt9

Document favorites3

Document labels3

Document permissions6

Documents16

Documents v27

Embed1

Folder favorites2

Folder labels1

Folder permissions5

Folders5

IP Allowlist2

Jobs1

Labels5

Model branches1

Model Git configuration7

Models17

Queries3

Schedule recipients6

Schedules10

Schema refresh schedules5

Skills5

Topics4

Uploads4

User attributes9

User group model roles2

User groups6

User model roles2

Users10

Who Am I1

Schedules

Create schedule

Changed on Nov 3, 2026

Create a scheduled task delivering a document's dashboard, or one tab of its workbook with entity: workbook. Supports applying filters and formatting, creating alert conditions, and triggering test deliveries.

Supports the following destinations:

Email
Slack - Note: A Slack workspace must already be connected to Omni to use this destination type.
SFTP
Webhook
Amazon S3

post/v1/schedules

Request

Base URL
https://blobsrus.omniapp.co/api
URL
https://blobsrus.omniapp.co/api/v1/schedules
Auth
HTTP bearer

Query parameters

userIdstring uuid

Only supported when using an Organization API key. The membership ID of the user who should own the schedule. The specified user must have permission to view and schedule the document, not just view it. Note: This value is the membership ID, not the user ID. Use the List users endpoint to retrieve membership IDs.

When using an Organization API key:

If userId is provided, the schedule is owned by the specified user
If userId is not provided, the schedule is owned by the organization

Attempting to use a Personal Access Token (PAT) with this parameter will result in a 403 Forbidden error. When using a PAT, the schedule owner will be the creator of the PAT.

Request body

Example request

{
  "name": "Weekly Sales Report",
  "schedule": "0 9 ? * MON *",
  "timezone": "America/New_York",
  "timezoneOverride": "Europe/Paris",
  "conditionQueryMapKey": "Jmn2r3KV",
  "conditionType": "RESULTS_PRESENT",
  "containerPages": [
    "01KXH5TG58BB5JBJHGTPC62RZA"
  ],
  "enableConditionalFormatting": true,
  "filterConfig": {
    "status": [
      "active",
      "pending"
    ]
  },
  "format": "pdf",
  "maxRowLimit": 1000,
  "paperFormat": "letter",
  "paperOrientation": "landscape",
  "queryIdentifierMapKey": "Jmn2r3KV",
  "showContentLink": true,
  "showFilters": true,
  "destinationType": "email",
  "filename": "weekly-sales-report",
  "subject": "Weekly Sales Report",
  "textBody": "Please find attached the weekly sales report."
}

Response

Schedule created successfully

idstring uuid

The ID of the created schedule.

messagestring

A success message.

delivererRoleArnstring

S3 destinations only. The ARN of Omni's deliverer IAM role. The customer uses this as the Principal in their IAM trust policy to allow Omni to assume their role.

externalIdstring

S3 destinations only. The organization ID, used as the external ID in the IAM trust policy sts:ExternalId condition. This value is the same for all S3 destinations in the organization.

Example response

{
  "message": "Successfully created schedule"
}

Changes

Nov 3, 202643290040f88f Revision changes
- breaking
  added subschema #1 subschema #2 to the request body allOf list
- breaking
  the request's body type changed from object to no type
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the non-success response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history