Update a materialization schedule for a data model element (Beta)

This endpoint updates the schedule of an existing materialization schedule for an element in a data model. Only the cron cadence and timezone are changed; the element must already have a materialization schedule.

For more details on materialization, see Materialization.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

Retrieve the dataModelId by calling the /v2/dataModels endpoint.
Retrieve the elementId by calling the /v2/dataModels/{dataModelId}/elements endpoint.
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.
The element must already have a materialization schedule. To create one, use the create data model materialization schedule endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

dataModelIdstringRequired

Unique identifier of the data model.

elementIdstringRequired

Identifier of the data model element to materialize on a schedule. Must be an element, such as a table, that can be materialized.

Request

The request body.

scheduleobjectRequired

When to run the materialization.

Response

The response body.

sheetIdstring

Identifier of the materialization schedule for the element

elementIdstring

Identifier of the element being materialized

elementNamestring

scheduleobject or null

configuredAtdatetime

pausedboolean