Schedules

Create schedule

Changed on Oct 21, 2026

Create a scheduled delivery of a document's dashboard, or of one workbook tab with entity: workbook. Required fields vary by entity and by destinationType (email, webhook, sftp, slack). For org API keys, use the userId query parameter to create the schedule on behalf of a specific user.

post/api/v1/schedules

Request

Base URL
https://omniapp.co (the document declares no server; this is the origin it was published from)
URL
https://omniapp.co/api/v1/schedules
Auth
HTTP bearer

Query parameters

userIdstring uuid

User ID of the user who should own the schedule (org API keys only). The user must be able to view and schedule the document. If not provided, the schedule is owned by the API key owner. User-scoped API keys cannot use this parameter.

Example:987fcdeb-51a2-43d7-9b56-254415f67890

Request body

Example request

{
  "name": "Weekly Sales Report",
  "schedule": "0 9 ? * MON *",
  "timezone": "America/New_York",
  "timezoneOverride": "Europe/Paris",
  "entity": "dashboard",
  "identifier": "12db1a0a",
  "conditionQueryMapKey": "Jmn2r3KV",
  "conditionType": "RESULTS_PRESENT",
  "containerPages": [
    "page_abc123"
  ],
  "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

delivererRoleArnstring

The ARN of the Omni deliverer role. Use this as the Principal in your IAM role trust policy. Only returned for S3 destinations.

externalIdstring uuid

The organization ID used as the external ID for confused deputy prevention. Add this to your IAM role trust policy as the sts:ExternalId condition. Static across all S3 destinations for your organization. Only returned for S3 destinations.

idstring uuid

Created schedule ID (only when testNow is false)

messagestring required

Success message

Example response

{
  "delivererRoleArn": "arn:aws:iam::529831494235:role/OmniSchedulerDelivererRole",
  "externalId": "550e8400-e29b-41d4-a716-446655440000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "Successfully created schedule"
}

Changes

Oct 21, 202677fb2f6f8669 Revision changes
- info
  added the new optional request property //
- info
  added the new optional request property //
Oct 15, 202694e352aa602f Revision changes
- breaking
  added subschema #1 subschema #2 to the request body allOf list
- breaking
  request body became required
- 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

Operation history (5 revisions)