Plan Availability: | All plan types |
Permissions: | User permissions mirror workspace access levels. |
Related Reading: |
Overview
The SmartSuite REST API includes dedicated bulk endpoints that allow you to manage multiple records in a single request. This feature enhances efficiency when performing repetitive tasks like adding, updating, or deleting records.
Note: SmartSuite may add new keys to response objects without notice, but existing keys will not be removed without prior deprecation warnings.
Authorization
SmartSuite uses token-based authentication for API access. All API requests must:
Be authenticated using your API key.
Include your Workspace ID in the request header.
Be made over HTTPS.
Headers for Authentication
Authorization: Token API_KEY_HERE Account-Id: WORKSPACE_ID_HERE
Finding Your Workspace ID
Your Workspace ID is the 8-character string in your SmartSuite URL: https://app.smartsuite.com/WORKSPACE_ID/
Bulk Record Endpoints
The following bulk endpoints are available in the v1 REST API:
Bulk Add Records
Endpoint: https://app.smartsuite.com/api/v1/applications/[tableId]/records/bulk/
Method: POST
Request Body Format:
{ "items": [ { "title": "record 1", "description": "test" }, { "title": "record 2", "description": "test2" }, { "title": "record 3", "description": "test3" } ] }Bulk Update Records
Endpoint: https://app.smartsuite.com/api/v1/applications/[tableId]/records/bulk/
Method: PATCH or PUT
Note: The update endpoint supports two types of record updates, with a PUT request performing a “destructive” update that clears all values in all records that are not specified in the update, and a PATCH request updating just those fields in all records included in the request.
Request Body Format:
{ "items": [ { "id": "6418b913ac9e9b98c222d5a3", "priority": "high" }, { "id": "6418b913ac9e9b98c222d5a4", "priority": "high" } ] }Bulk Delete Records
Endpoint: https://app.smartsuite.com/api/v1/applications/[tableId]/records/bulk_delete/?fields=id
Method: PATCH
Request Body Format:
{ "items": [ "6418b7a1f2f4056dd0279a54", "6418b7a2fe6b4a731195c245", "6418b7a2db77680b279fd3f8" ] }Practical Scenarios and Use Cases
1. Efficient Data Management
Scenario: A team needs to import hundreds of new customer records.
Solution: Use the bulk add endpoint to upload all records in one API call.
2. Bulk Status Updates
Scenario: Update the priority level for multiple records in a project.
Solution: Use the bulk update endpoint with the PATCH method to modify only the necessary fields.
3. Clean-Up Operations
Scenario: Remove outdated or redundant records from a solution.
Solution: Use the bulk delete endpoint to efficiently clear unnecessary data.