Sign in
actions

Update an action

patch/actions/{actionId}

Path parameters

actionIdstring required

Action ID

The id of the action to patch

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

slugstring

This is deprecated. Use operation instead.

operationstring

This will become the job operation that is triggered

mode'foreground' | 'background' | 'toolbarBlocking'

Foreground actions will prevent interacting with the resource until complete

tooltipstring

A tooltip that appears when hovering the action button

typestring

This is deprecated.

descriptionstring

The text that appears in the dialog after the action is clicked.

schedule'weekly' | 'daily' | 'hourly'
primaryboolean

A primary action will be more visibly present, whether in Sheet or Workbook.

confirmboolean

Whether to show a modal to confirm the action

iconstring

Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.

requireAllValidboolean

This is deprecated. Use constraints instead.

requireSelectionboolean

This is deprecated. Use constraints instead.

createdFromstring

Action ID

lastPropagatedAtstring date-time

The last time this action was propagated to a workbook

deletedAtstring date-time

The time this action was deleted

invalidConditionalMessagingboolean

When enabled, shows dynamic confirmation messages based on record validation status instead of the static description

validRecordsMessagestring

Custom message to show when all records are valid (only used when invalidConditionalMessaging is true)

invalidRecordsMessagestring

Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true)

labelstring

Response

Response with status 200

Changes