Bulk Add Records

POST

https://app.smartsuite.com/api/v1/applications/[tableId]/records/bulk/

Creates multiple records. Your request body should include an array (items) of up to 25 records. Each of those objects should be properly formed record objects.

Notice

Including more than 25 records will result in the server returning a 422 error. Note that the bulk endpoint does not currently enforce required fields and therefore does not return a 422 (as does the single record add) when a required field is missing.

Example Request

curl -X POST https://app.smartsuite.com/api/v1/applications/6451093119bcf22befaed847/records/bulk/ \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "ACCOUNT-ID: WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  --data '{
    "items": [
        {
            "title":"record 1",
            "description":"test"
        },
        {
            "title":"record 2",
            "description":"test2"
        },
        {
            "title":"record 3",
            "description":"test3"
        }
    ]
}'

Path Parameters

Param	Type	Description
tableId	string	The Id of the Table (App) in which to create the records.

Request Body

Param	Type	Optional	Description
items	array of objects	No	An Array of record objects

caution

Bulk Add Records does not enforce required fields. A record missing a required field is created, where Create Record would return 400. Validate required values before you send them.

Response

Returns 201 Created with an array of the created record objects.

201 Response - Example

[
    {
        "title": "record 1",
        "description": {
            "data": {
                "type": "doc",
                "content": [
                    {
                        "type": "paragraph",
                        "content": [
                            {
                                "type": "text",
                                "text": "test"
                            }
                        ]
                    }
                ]
            },
            "html": "<div class=\"rendered\">\n    <p>test</p>\n</div>",
            "preview": "test",
            "yjsData": null
        },
        "assigned_to": [],
        "status": {
            "value": "backlog",
            "updated_on": null
        },
        "due_date": {
            "from_date": {
                "date": null,
                "include_time": false
            },
            "to_date": {
                "date": null,
                "include_time": false
            },
            "is_overdue": false,
            "status_is_completed": false,
            "status_updated_on": null
        },
        "priority": "",
        "first_created": {
            "on": "2024-08-15T22:04:15.887039Z",
            "by": "63a1f65723aaf6bcb564b1f1"
        },
        "last_updated": {
            "on": "2024-08-15T22:04:15.887122Z",
            "by": "63a1f65723aaf6bcb564b1f1"
        },
        "followed_by": [],
        "comments_count": null,
        "autonumber": 3,
        "sf20bfec60": [],
        "s630009358": {
            "date": null,
            "include_time": false
        },
        "sukadqxp": {
            "date": null,
            "include_time": false
        },
        "id": "66be7b5fb8b730607ea959f4",
        "application_slug": "sbwchxhv",
        "application_id": "65f194001c0091a8180f8b2b",
        "ranking": {
            "default": "aaaaaabsjw"
        },
        "deleted_date": {
            "date": null,
            "include_time": false
        },
        "deleted_by": null
    }
]