---
title: "POST /api/im/schedules/{id}/preview"
method: POST
path: "/api/im/schedules/{id}/preview"
tags: ["Im"]
---

# POST /api/im/schedules/{id}/preview

`POST /api/im/schedules/{id}/preview`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/im/schedules/{id}/preview`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- object
  - `overrides` object[]: Unsaved overrides to preview with; absent = the stored overrides.
    - `userId` string, required
    - `startsAt` string, date-time, required
    - `endsAt` string, date-time, required
    - `type` 'online' | 'offline'
    - `coveredByUserIds` string[]

## Response `200`

Successful response

- object
  - `from` string, date-time, required
  - `to` string, date-time, required
  - `timezone` string, required
  - `shifts` object[], required
    - `userId` string, required
    - `layerIndex` integer, required
    - `startsAt` string, date-time, required
    - `endsAt` string, date-time, required
    - `isOverride` boolean, required
  - `gaps` object[], required
    - `from` string, date-time, required
    - `to` string, date-time, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `404`: No such resource, or not visible to this token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)