Sheet Options
configurable properties for a Sheet
This is legacy documentation maintained for backward compatibility. For the
latest documentation, please refer to the current guides.
The name of your Sheet as it will appear to your end users.
A sentence or two describing the purpose of your Sheet.
A unique identifier for your Sheet. Used to reference your Sheet in code, for
example in a Record Hook.
A boolean specifying whether or not this sheet is read only. Read only sheets
are not editable by end users.
When this is set to
true, your Sheet will be able to accept additional
fields beyond what you specify in its configuration. These additional fields
can be added via API, or by end users during the file import process. These
fields will have a treatment of “user-defined”.An array specifying the access controls for this Sheet. Read more about
access controls.
This is where you define your Sheet’s data schema. The collection of fields in
your Sheet determines the shape of data you wish to accept.Learn more about Field types,
Constraints, and
Relationships.
An array of actions that end users can perform on this Sheet. Read more about
actions.
Use
metadata to store any extra contextual information about your Sheet.
Must be valid JSON. This metadata can be updated at any time through the
workbook update endpoint by including the metadata field in the sheet
configuration.Use
mappingConfidenceThreshold to configure the minimum required confidence
for mapping jobs targeting that sheet. This can be used to tune the behavior
of fuzzy matches, or disable fuzzy matches entirely. Must be greater than 0
and less than or equal to 1 (exact match)Use the
constraints option to define constraints for a specific Sheet. Learn
more about Constraints.