---
title: "Create a materialization schedule for a workbook element (Beta)"
method: POST
path: "/v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules"
tags: ["Workbooks"]
---

# Create a materialization schedule for a workbook element (Beta)

`POST /v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules`
- Auth: HTTP bearer

This endpoint creates a materialization schedule for an element in a workbook. The scheduled run materializes the element's data on the given cadence, allowing the data to be stored or cached for optimized access and performance.

  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).

  **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.

  ### Usage notes
  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.
  - Retrieve the **elementId** by calling the [/v2/workbooks/{workbookId}/elements](https://help.sigmacomputing.com/reference/list-workbook-elements) endpoint.
  - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.
  - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.
  - An element can have at most one materialization schedule.
  - The materialization run starts immediately upon creation using the latest published version of the workbook.

## Path parameters

- `workbookId` string, required
- `elementId` string, required

## Request body

- object
  - `schedule` V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPostRequestBodyContentApplicationJsonSchemaSchedule, required: When to run the materialization.
    - `cronSpec` string, required: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`.
    - `timezone` string: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone.

## Response `201`

The newly created materialization schedule.

- WorkbooksCreateMaterializationScheduleResponse201: The newly created materialization schedule.
  - `sheetId` string, required: Identifier of the materialization schedule for the element
  - `elementId` string, required: Identifier of the element being materialized
  - `elementName` string, required
  - `schedule` V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPostResponsesContentApplicationJsonSchemaSchedule, required
    - `cronSpec` string: Cron expression to use for the schedule
    - `timezone` string: Timezone code, for example, PST
  - `configuredAt` string, date-time, required
  - `paused` boolean, required

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)