What is the Multiple Records Creation API?
You can add multiple records to a certain form through the Multiple Records Creation API.
Note:
If you use the API to create records, the following events can be triggered: record submission notifying, aggregation table calculation & validation, data operation log recording, and data volume statistics. It is also possible to decide whether to initiate a workflow through request parameters. However, validations on duplicate values and required fields will not be triggered.
Records creating and updating are forbidden in the system fields and the following fields.
Divider
Signature
RelatedData and RelatedQuery
Serial No. (Automatically generated)
Version Description
API Version | Updated Time | Version Description |
V 1 | 2022.10.28 | The API request frequency is increased from five times per second to ten times per second. The parameters "app_id" and "entry_id" are put in the body and the API route is changed to "POST app/entry/data/batch_create". |
2023.08.31 | A new request parameter "data_creator" is added. |
|
API Calling
Add multiple records to a certain form. A maximum of 100 records can be created at a time.
Request Frequency: 10 times/second
Request Method: POST
Request Parameters:
Parameter | Type | Required | Description | Default |
app_id | String | Yes | App ID | / |
entry_id | String | Yes | Form ID | / |
data_list | Array | Yes | Records to add. | / |
data_creator | String | No | The member who submits data. The value for "data_creator" is the member's NO.. You can obtain the member number through the contact APIs. | Business owner |
transaction_id | String | No | Transaction ID; transaction_id is used to uniquely identify a transaction and prevent duplicate transactions from being created. It is also used to bind a batch of files. UUIDs are often used to generate unique Transaction IDs. | / |
is_start_workflow | Bool | No | Whether to initiate workflows (only work in workflow forms) | false |
Sample Request:
{
"app_id": "59264073a2a60c0c08e20bfb",
"entry_id": "59264073a2a60c0c08e20bfd",
"transaction_id": "87cd7d71-c6df-4281-9927-469094395677", // Transaction ID
"data_list": [
{
"_widget_1432728651402": { // Single Line
"value": "Jodoo 1"
},
"_widget_1432728651403": { // Number
"value": 100
},
"_widget_1528854613291": { // Subform
"value": [
{ // The structure of subform records are the same as that of form records
"_widget_1528854614409": {
"value": "Subform record 11"
},
"_widget_1528854615499": {
"value": 1001
}
},
{
"_widget_1528854614410": {
"value": "Subform record 12"
},
"_widget_1528854615419": {
"value": 1002
}
}
]
}
},
{
"_widget_1432728651402": {
"value": "Jodoo 2"
},
"_widget_1432728651403": {
"value": 200
},
"_widget_1528854613291": {
"value": [
{
"_widget_1528854614409": {
"value": "Subform record 21"
},
"_widget_1528854615499": {
"value": 2001
}
}
]
}
},
{
"_widget_1432728651402": {
"value": "Jodoo 3"
},
"_widget_1432728651403": {
"value": 300
},
"_widget_1528854613291": {
"value": [
{
"_widget_1528854614410": {
"value": "Subform record 31"
},
"_widget_1528854615419": {
"value": 3001
}
}
]
}
}
],
"is_start_workflow": true
}
Response:
Parameter | Type | Description |
status | String | Return the request result |
success_count | Number | Number of records successfully added |
success_ids | Array | List of IDs of the records successfully added |
Response Example:
{
"status": "success",
"success_count": 3,
"success_ids": [
"200001181fe09728936510eb",
"200001181fe09728936510ec",
"200001181fe09728936510ed"
]
}
More to Know
1. If you encounter any failure when creating multiple records, do the following:
Use the same transaction_id to create all records again. The failed records submitted in the first attempt will be added, but the successful records will not.
2. If you add "data_creator" parameters and specify data creators, the members who executed the triggered Automations and the members who initiated workflows will be data creators.
I have finished reading. 🏆
👉I can't wait to SET THE API.
👉I need more HELP in Discord Forum.