API ReferenceActions

Create an action

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

Query parameters

spaceIdstringRequired
The Space ID for which to create the Action.

Request

This endpoint expects an object.
labelstringRequired
The text on the Button itself
targetIdstringRequired
confirmbooleanOptional
Whether to show a modal to confirm the action
constraintslist of objectsOptional
A limitation or restriction on the action.
createdFromstringOptional
The action that this action was cloned from
deletedAtdatetimeOptional
The time this action was deleted
descriptionstringOptional
The text that appears in the dialog after the action is clicked.
guardrailobjectOptional
guideobjectOptional
iconstringOptional
Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.
inputFormobjectOptional
Adds an input form for this action after it is clicked.
lastPropagatedAtdatetimeOptional
The last time this action was propagated to a workbook
messageslist of objectsOptional
modeenumOptional
Foreground and toolbarBlocking action mode will prevent interacting with the resource until complete
Allowed values:
mountobjectOptional
operationstringOptional
This will become the job operation that is triggered
primarybooleanOptional
A primary action will be more visibly present, whether in Sheet or Workbook.
scheduleenumOptional
Determines if the action should happen on a regular cadence.
Allowed values:
tooltipstringOptional
A tooltip that appears when hovering the action button
typestringOptional

This is deprecated.

requireAllValidbooleanOptionalDeprecated

This is deprecated. Use constraints instead.

requireSelectionbooleanOptionalDeprecated

This is deprecated. Use constraints instead.

slugstringOptionalDeprecated

This is deprecated. Use operation instead.

Response

This endpoint returns an object.
dataobject