Skip to navigation
Sigma REST APIWorkbookselements

Delete a materialization schedule for a workbook element (Beta)

View as Markdown

This endpoint deletes the materialization schedule for an element in a workbook. Any subsequent scheduled materialization runs for the element are cancelled. 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 workbookId by calling the /v2/workbooks endpoint.
  • Retrieve the elementId by calling the /v2/workbooks/{workbookId}/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 workbook element must already have a materialization schedule.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.
elementIdstringRequired
Identifier of the workbook element to materialize on a schedule. Must be an element, such as a table or visualization, that can be materialized.

Response

The response body.