CommunityCreate AccountSign in
  • Overview
    • Welcome
    • Authentication
    • Using Environments
  • API Reference
LogoLogo
LogoLogo
CommunityCreate AccountSign in
API ReferenceActions

POST
https://api.x.flatfile.com/v1/actions/bulk
POST
/v1/actions/bulk
1curl -X POST "https://api.x.flatfile.com/v1/actions/bulk?spaceId=spaceId" \
2     -H "X-Disable-Hooks: true" \
3     -H "Authorization: Bearer <token>" \
4     -H "Content-Type: application/json" \
5     -d '[
6  {
7    "label": "label",
8    "targetId": "targetId"
9  },
10  {
11    "label": "label",
12    "targetId": "targetId"
13  }
14]'
Try it
200Successful
1[
2  {
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  {
92    "createdAt": "2024-01-15T09:30:00Z",
93    "id": "id",
94    "label": "label",
95    "targetId": "targetId",
96    "updatedAt": "2024-01-15T09:30:00Z",
97    "confirm": true,
98    "constraints": [
99      {
100        "type": "hasAllValid",
101        "ignoreSelection": true
102      },
103      {
104        "type": "hasAllValid",
105        "ignoreSelection": true
106      }
107    ],
108    "createdFrom": "createdFrom",
109    "deletedAt": "2024-01-15T09:30:00Z",
110    "description": "description",
111    "guardrail": {
112      "content": "content"
113    },
114    "guide": {
115      "content": "content"
116    },
117    "icon": "icon",
118    "inputForm": {
119      "type": "simple",
120      "fields": [
121        {
122          "key": "key",
123          "label": "label",
124          "type": "type",
125          "description": "description",
126          "defaultValue": {
127            "key": "value"
128          },
129          "config": {
130            "options": []
131          },
132          "constraints": []
133        },
134        {
135          "key": "key",
136          "label": "label",
137          "type": "type",
138          "description": "description",
139          "defaultValue": {
140            "key": "value"
141          },
142          "config": {
143            "options": []
144          },
145          "constraints": []
146        }
147      ]
148    },
149    "invalidConditionalMessaging": true,
150    "invalidRecordsMessage": "invalidRecordsMessage",
151    "lastPropagatedAt": "2024-01-15T09:30:00Z",
152    "messages": [
153      {
154        "type": "error",
155        "content": "content"
156      },
157      {
158        "type": "error",
159        "content": "content"
160      }
161    ],
162    "mode": "foreground",
163    "mount": {
164      "type": "sheet",
165      "slugs": [
166        "slugs",
167        "slugs"
168      ]
169    },
170    "operation": "operation",
171    "primary": true,
172    "schedule": "weekly",
173    "tooltip": "tooltip",
174    "type": "type",
175    "validRecordsMessage": "validRecordsMessage",
176    "requireAllValid": true,
177    "requireSelection": true,
178    "slug": "slug"
179  }
180]
Was this page helpful?
Previous

Get all actions for the space

Next
Built with
Create several actions

Authentication

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

Headers

X-Disable-Hooks"true"Required

Query Parameters

spaceIdstringRequired
The Space ID for which to create the Actions.

Request

This endpoint expects a list of objects.
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.
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)
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 a list of objects.
createdAtdatetime
idstring
Action ID
labelstring
The text on the Button itself
targetIdstring
updatedAtdatetime
confirmboolean or null
Whether to show a modal to confirm the action
constraintslist of objects or null
A limitation or restriction on the action.
createdFromstring or null
The action that this action was cloned from
deletedAtdatetime or null
The time this action was deleted
descriptionstring or null
The text that appears in the dialog after the action is clicked.
guardrailobject or null
guideobject or null
iconstring or null
Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.
inputFormobject or null
Adds an input form for this action after it is clicked.
invalidConditionalMessagingboolean or null
When enabled, shows dynamic confirmation messages based on record validation status instead of the static description
invalidRecordsMessagestring or null
Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true)
lastPropagatedAtdatetime or null
The last time this action was propagated to a workbook
messageslist of objects or null
modeenum or null
Foreground and toolbarBlocking action mode will prevent interacting with the resource until complete
Allowed values:
mountobject or null
operationstring or null
This will become the job operation that is triggered
primaryboolean or null
A primary action will be more visibly present, whether in Sheet or Workbook.
scheduleenum or null
Determines if the action should happen on a regular cadence.
Allowed values:
tooltipstring or null
A tooltip that appears when hovering the action button
typestring or null
**This is deprecated.**
validRecordsMessagestring or null
Custom message to show when all records are valid (only used when invalidConditionalMessaging is true)
requireAllValidboolean or nullDeprecated
**This is deprecated. Use `constraints` instead.**
requireSelectionboolean or nullDeprecated
**This is deprecated. Use `constraints` instead.**
slugstring or nullDeprecated
**This is deprecated. Use `operation` instead.**

This is deprecated. Use constraints instead.

This is deprecated.

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

This is deprecated. Use constraints instead.

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

This is deprecated. Use operation instead.

This is deprecated. Use operation instead.

This is deprecated. Use constraints instead.

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

This is deprecated.

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

This is deprecated. Use constraints instead.

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