---
title: "Create a schedule"
method: POST
path: "/orgs/{orgId}/schedules"
tags: ["orgs/schedules"]
---

# Create a schedule

`POST /orgs/{orgId}/schedules`

__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-user:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createSchedule

## Path parameters

- `orgId` integer, required

## Request body

- object
  - `name` string, required
  - `scheduleTypeId` integer, required

## Response `201`

Created

- object
  - `data` object
    - `id` number, required
    - `name` string
    - `scheduleType` object
      - `id` number, required
      - `name` string
    - `entries` object[]
      - `id` number, required
      - `name` string
    - `zoneUsers` object[]
      - `zone` object
        - `id` number, required
        - `name` string
      - `user` object
        - `id` number, required
        - `opal` string
        - `status` string
        - `startDate` string, date, nullable
        - `endDate` string, date, nullable
        - `identity` object
          - `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
              - …
            - `totpSoftDevice` object
              - …
          - `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
              - …
            - `org` object
              - …
            - `identityProvider` object
              - …
          - `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
              - …
    - `zoneGroups` object[]
      - `zone` object
        - `id` number, required
        - `name` string
      - `group` object
        - `id` number, required
        - `name` string
    - `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.net/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.net/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/versions/d8a888c114fa/schema)