The REST API can add, update or delete up to 25 records in one request. You send the records as an items array to the bulk endpoint of one table.
Each bulk request counts as one API request, however many records it carries.
Example: a vendor risk team loads 60 new vendors from a procurement export. The script sends three bulk requests of 25, 25 and 10 records to the Vendors table.
Plan Availability | All plan types. API requests per month: 25,000 on Team, 100,000 on Professional, 500,000 on Enterprise, custom on Signature. |
Permissions | Any member with an API key. The key acts with that member's role and permissions. |
Platform | API |
Related Reading |
Which bulk endpoints are there?
Action. | Method. | Endpoint. |
Add records. | POST. | |
Update records. | PATCH or PUT. | |
Delete records. | PATCH. |
[tableId] is the ID of the table. The solution's API Documentation lists it.
Every request carries your API key and your Workspace ID:
Authorization: Token API_KEY_HERE
Account-Id: WORKSPACE_ID_HERE
Note: One bulk request carries up to 25 records. Split a larger set into requests of 25.
Adding records in bulk
Send an items array with one object per record. Use the field slugs as keys.
{
"items": [
{
"title": "record 1",
"description": "test"
},
{
"title": "record 2",
"description": "test2"
}
]
}Updating records in bulk
Send an items array. Each object carries the record id and the fields to change.
{
"items": [
{
"id": "6418b913ac9e9b98c222d5a3",
"priority": "high"
},
{
"id": "6418b913ac9e9b98c222d5a4",
"priority": "high"
}
]
}
Warning: PATCH changes only the fields you send. PUT clears every field you leave out, in every record of the request.
Deleting records in bulk
Send an items array of record IDs, as plain strings.
{
"items": [
"6418b7a1f2f4056dd0279a54",
"6418b7a2fe6b4a731195c245"
]
}
Deleted records go to the Recycle Bin for the plan's retention period: 30 days on Team, 45 on Professional, and 60 on Enterprise and Signature.
Note: Send bare ID strings, not objects. A list of objects such as {"id": "..."} returns 200 OK but deletes nothing.
Frequently asked questions
How many records can one bulk request carry?
How many records can one bulk request carry?
Up to 25. Split a larger set into requests of 25 records each. Every request counts as one API request.
Do bulk requests count toward my API allowance?
Do bulk requests count toward my API allowance?
Yes. Each bulk request is one request against the monthly allowance, however many records it carries.
Should I use PATCH or PUT to update?
Should I use PATCH or PUT to update?
PATCH, unless you mean to clear every field you do not send. PUT replaces the whole record with the values in the request.
Can I add fields in bulk through these endpoints?
Can I add fields in bulk through these endpoints?
No. These endpoints work on records in one table. Fields are added through the Metadata API. See Metadata API documentation.
Need more help? Ask the SmartSuite Community, where builders, administrators and the SmartSuite team answer questions about building on SmartSuite. For your account, billing or data, select the chat button in the lower-right corner of SmartSuite to reach support.
Last verified 1 Nov 2026.
