Update an action | Flatfile

Path parameters

actionIdstringRequired

The id of the action to patch

Request

This endpoint expects an object.

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.

invalidConditionalMessagingbooleanOptional

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

invalidRecordsMessagestringOptional

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

labelstringOptional

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.

validRecordsMessagestringOptional

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

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

1	from flatfile import Flatfile
2
3	client = Flatfile(
4	token="YOUR_TOKEN",
5	)
6	client.actions.update(
7	action_id="actionId",
8	)

1	{
2	"data": {
3	"createdAt": "2024-01-15T09:30:00Z",
4	"id": "id",
5	"label": "label",
6	"targetId": "targetId",
7	"updatedAt": "2024-01-15T09:30:00Z",
8	"confirm": true,
9	"constraints": [
10	{
11	"type": "hasAllValid",
12	"ignoreSelection": true
13	},
14	{
15	"type": "hasAllValid",
16	"ignoreSelection": true
17	}
18	],
19	"createdFrom": "createdFrom",
20	"deletedAt": "2024-01-15T09:30:00Z",
21	"description": "description",
22	"guardrail": {
23	"content": "content"
24	},
25	"guide": {
26	"content": "content"
27	},
28	"icon": "icon",
29	"inputForm": {
30	"type": "simple",
31	"fields": [
32	{
33	"key": "key",
34	"label": "label",
35	"type": "type",
36	"description": "description",
37	"defaultValue": {
38	"key": "value"
39	},
40	"config": {
41	"options": []
42	},
43	"constraints": []
44	},
45	{
46	"key": "key",
47	"label": "label",
48	"type": "type",
49	"description": "description",
50	"defaultValue": {
51	"key": "value"
52	},
53	"config": {
54	"options": []
55	},
56	"constraints": []
57	}
58	]
59	},
60	"invalidConditionalMessaging": true,
61	"invalidRecordsMessage": "invalidRecordsMessage",
62	"lastPropagatedAt": "2024-01-15T09:30:00Z",
63	"messages": [
64	{
65	"type": "error",
66	"content": "content"
67	},
68	{
69	"type": "error",
70	"content": "content"
71	}
72	],
73	"mode": "foreground",
74	"mount": {
75	"type": "sheet",
76	"slugs": [
77	"slugs",
78	"slugs"
79	]
80	},
81	"operation": "operation",
82	"primary": true,
83	"schedule": "weekly",
84	"tooltip": "tooltip",
85	"type": "type",
86	"validRecordsMessage": "validRecordsMessage",
87	"requireAllValid": true,
88	"requireSelection": true,
89	"slug": "slug"
90	}
91	}

Path parameters

Headers

Request

Response