---
title: "POST /rest/v1/work-schedules"
method: POST
path: "/rest/v1/work-schedules"
---

# POST /rest/v1/work-schedules

`POST /rest/v1/work-schedules`

Creates a new WorkSchedule item for a given employee at a given location.

## Request body

- object
  - `workSchedule` CreateWorkScheduleInput, required
    - `locationId` string, required — The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
    - `email` string, required — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
    - `expectedArrivalAt` string, date-time, required — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

## Response `default`

WorkSchedule!

- object
  - `data` WorkSchedule, required — A Work-Schedule are days that a user has selected to work physically on-site at a specific location.
    - `id` string, required — The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
    - `expectedArrivalAt` string, date-time — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
    - `expectedDepartureAt` string, date-time — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
    - `arrivedAt` string, date-time — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
    - `departedAt` string, date-time — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
    - `flowId` string, required — The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
    - `locationId` string, required — The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
    - `status` union, required
      - 'PENDING' — This WorkSchedule item is on the calendar, and is pending capacity or employee screening checks.
      - 'APPROVED' — This WorkSchedule item has cleared all checks, and the employee is approved to visit the location.
      - 'DENIED' — This WorkSchedule item is denied due to failing an employee screening check or because the location is at capacity.
    - `registrationURL` string, required — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
    - `scheduledFor` object, required — Describes a user.
      - `id` string — The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
      - `type` union, required
        - 'EMPLOYEE' — The type of user e.g. EMPLOYEE
        - 'CALENDAR_CLIENT' — The type of user e.g. EMPLOYEE
      - `name` string, required — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
      - `email` string — The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
    - `createdAt` string, date-time, required — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
    - `updatedAt` string, date-time, required — A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
    - `reservations` ID[] — The associated reservation ids attached to this work schedule
  - `meta` object
    - `messages` string[] — Optional scope information.

---

[API](https://skmtc.net/envoy/apis/envoy-developer-api.md) · [All operations](https://skmtc.net/envoy/apis/envoy-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/envoy/envoy-developer-api/revisions/51c85bc66c44/schema)