ONoneschema
Workspace Sheets

Assign a template to a Workspace sheet

Assign or unassign a template for a Workspace sheet. Pass template_key: null to unassign the current template.

Set auto_set_header_row to true to automatically detect and set the header row before applying the template. If the sheet's headers are already set, auto_set_header_row is ignored.

put/v1/sheets/{sheet_id}/template

Request

  • Base URL
    https://api.oneschema.co
  • URL
    https://api.oneschema.co/v1/sheets/{sheet_id}/template
  • Auth
    API key in header X-API-KEY

Path parameters

sheet_idinteger required

The id of the sheet.

Request body

template_keystring nullable required

The unique key of the template to assign to the sheet. Pass null to unassign the current template.

auto_set_header_rowboolean

Whether to automatically detect and set the header row before applying the template. Ignored if the sheet's headers are already set.

Response

The request has succeeded.

idinteger required

The unique identifier of the sheet.

workspace_idinteger required

The ID of the Workspace that contains the sheet.

namestring required

The name of the sheet.

template_keystring nullable

The unique key of the template assigned to the sheet, if any.

custom_metadataobject nullable

Custom metadata associated with the sheet.

Changes

No recorded changes to this operation across all 1 revision of this API.