---
title: "Create a new scheduled report task."
method: POST
path: "/orgs/{orgId}/tasks/reports/schedules"
tags: ["orgs/tasks"]
---

# Create a new scheduled report task.

`POST /orgs/{orgId}/tasks/reports/schedules`

The cronTime value uses a restricted cron time format: `minute hour day-of-month month days-of-week`.Specifically, the cronTime is restricted to support only a daily, weekly, monthly or 1st day of the quarter. Daily is supported through a `min hr * * *` cronTime for daily execution at hr:min time. Weekly is supported through a `min hr * * <day-of-week1>,<dow2>,...` cronTime for weekly execution at hr:min time on `<dow#>` days (e.g. 0=Sunday, 1=Monday). Monthly is supported through a `min hr day * *` cronTime for monthly execution on <day> at hr:min time. 1st day of quarter is supported through a `min hr 1 1,4,7,10 *` cronTime for 1st day of quarter execution at hr:min time.<br/><br/>The randomDelaySecs provides the number of seconds to delay the start of execution. The minimum required delay is 3 hours.<br/><br/>The params field provides the report specific options. See /orgs/{orgId}/tasks/reports help for details.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createTasksReportsSchedule

## Path parameters

- `orgId` integer, required

## Request body

- object
  - `cronTime` string, required
  - `cronTimeZone` string, required
  - `params` object, required
    - `executionType` 'immediate' | 'scheduled'
    - `options` string, nullable
    - `expiresAfter` string, date
    - `type` 'activityLogsOrg' | 'alarmsOrg' | 'occupancyOrg' | 'auditLogsOrg', required
    - `name` string, required
    - `filter` string, nullable
    - `relativeTime` 'today' | 'thisWeek' | 'thisMonth' | 'thisQuarter' | 'thisYear' | 'yesterday' | 'lastFullWeek' | 'lastFullMonth' | 'lastFullQuarter' | 'last6FullMonths' | 'last12FullMonths'
    - `customFieldIds` integer[], nullable
    - `destinationEmails` string[], nullable
    - `timeZone` string, nullable
    - `columns` string[], nullable
    - `expiresAfterDays` integer
  - `randomDelaySecs` integer, required
  - `options` string, nullable

## Response `201`

Created

- object
  - `data` object
    - `cronTime` string, required
    - `cronTimeZone` string, required
    - `params` object, required
      - `executionType` 'immediate' | 'scheduled'
      - `options` string, nullable
      - `expiresAfter` string, date
      - `type` 'activityLogsOrg' | 'alarmsOrg' | 'occupancyOrg' | 'auditLogsOrg', required
      - `name` string, required
      - `filter` string, nullable
      - `relativeTime` 'today' | 'thisWeek' | 'thisMonth' | 'thisQuarter' | 'thisYear' | 'yesterday' | 'lastFullWeek' | 'lastFullMonth' | 'lastFullQuarter' | 'last6FullMonths' | 'last12FullMonths'
      - `customFieldIds` integer[], nullable
      - `destinationEmails` string[], nullable
      - `timeZone` string, nullable
      - `columns` string[], nullable
      - `expiresAfterDays` integer
    - `randomDelaySecs` integer, required
    - `id` integer, required
    - `org` object
      - `id` integer, required
      - `name` string
    - `identity` object, required
      - `id` number, required
      - `opal` string
      - `roles` object[]
        - `id` number, required
        - `name` string
        - `description` string
        - `isMfaRequired` boolean
      - `mfaCredentials` object[]
        - `id` number, required
        - `createdAt` string, date
        - `updatedAt` string, date
        - `name` string
        - `status` string
        - `mfaCredentialType` object
          - `id` number, required
          - `name` string
          - `modelName` string
        - `totpSoftDevice` object
          - `id` number, required
      - `firstName` string, nullable
      - `middleName` string, nullable
      - `lastName` string, nullable
      - `fullName` string, nullable
      - `initials` string, nullable
      - `isEmailVerified` boolean
      - `namespace` object
        - `id` integer, required
        - `nickname` string, nullable
        - `namespaceType` object
          - `id` number, required
          - `name` string
          - `modelName` string, nullable
        - `org` object
          - `id` number, required
          - `name` string
        - `identityProvider` object
          - `id` number, required
          - `isSsoEnabled` boolean
          - `isSyncMobilePhoneEnabled` boolean
          - `isRemoveGroupsEnabled` boolean
          - `identityProviderSyncTypeId` integer, nullable
          - `credentials` string, nullable
          - `identityProviderType` object
            - `id` number, required
            - `name` string
          - `org` object
            - `id` number, required
            - `name` string
      - `idpUniqueIdentifier` string
      - `pmsUniqueIdentifier` string, nullable
      - `needsPasswordChange` boolean
      - `nicknames` object[], nullable
        - `nickname` string
      - `email` string
      - `mobilePhone` string, nullable
      - `language` string, nullable
      - `createdAt` string, date
      - `updatedAt` string, date
      - `users` object[]
        - `id` number, required
        - `opal` string
        - `status` string
        - `startDate` string, date, nullable
        - `endDate` string, date, nullable
        - `createdAt` string, date
        - `updatedAt` string, date
        - `org` object
          - `id` number, required
          - `name` string, nullable
    - `siteIdsFilter` integer[], nullable
    - `nextStartAt` string, date, nullable
    - `lastStartedAt` string, date, nullable
    - `createdAt` string, date
    - `updatedAt` string, date
  - `meta` object
    - `accessToken` object, nullable
      - `scopeUpdatedAt` string, date
    - `siteSpecificAccess` object, nullable
      - `isSiteSpecific` boolean
      - `siteIds` integer[], nullable
      - `siteIdsByScope` object, nullable
        - `string` integer[], nullable

---

[API](https://skmtc.dev/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.dev/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/revisions/d8a888c114fa/schema)