Batch create endpoint design in Rest API

Introduction

Batch create endpoints let you add many items at once. This saves time and reduces the number of requests.

When users need to upload multiple records in one go, like adding many contacts.

When importing data from a file with many entries.

When syncing data from another system that sends multiple items together.

When you want to reduce network calls to improve speed.

When your app needs to create many related objects quickly.

Syntax

Rest API

POST /items/batch
Content-Type: application/json

{
  "items": [
    {"name": "Item1", "value": 10},
    {"name": "Item2", "value": 20}
  ]
}

The HTTP method is usually POST because you are creating new data.

The request body contains an array of objects inside a key like "items".

Examples

Batch create users by sending an array of user objects.

Rest API

POST /users/batch
Content-Type: application/json

{
  "users": [
    {"username": "alice", "email": "[e-mail]"},
    {"username": "bob", "email": "[e-mail]"}
  ]
}

Batch create products with their name and price.

Rest API

POST /products/batch
Content-Type: application/json

{
  "products": [
    {"name": "Pen", "price": 1.5},
    {"name": "Notebook", "price": 3.0}
  ]
}

Sample Program

This request creates two tasks at once: "Buy milk" and "Walk dog".

Rest API

POST /tasks/batch
Content-Type: application/json

{
  "tasks": [
    {"title": "Buy milk", "done": false},
    {"title": "Walk dog", "done": false}
  ]
}

Important Notes

Always validate each item in the batch to avoid partial failures.

Return clear success or error info for each item in the response.

Limit batch size to avoid overloading the server.

Summary

Batch create endpoints let you add many items with one request.

Use POST with a JSON array of objects inside a named key.

Handle validation and response carefully for each item.

Practice

1. What HTTP method is typically used for a batch create endpoint in a REST API?

easy

A. DELETE

B. POST

C. GET

D. PUT

Solution

1. Step 1: Understand HTTP methods for data creation

   POST is used to create new resources on the server.

2. Step 2: Apply to batch create context

   Batch create sends multiple new items in one POST request.

3. Final Answer:

   POST -> Option B

4. Quick Check:

   Batch create uses POST [OK]

Hint: Batch create always uses POST method [OK]

Common Mistakes:

• Using GET which is for reading data
• Using DELETE which removes data
• Using PUT which replaces resources

2. Which of the following is the correct JSON format for sending multiple items in a batch create request body?

easy

A. {"name": "item1", "name": "item2"}

B. [{"name": "item1"}, {"name": "item2"}]

C. {"items": [{"name": "item1"}, {"name": "item2"}]}

D. {"item1": "name", "item2": "name"}

Solution

1. Step 1: Identify JSON array structure for batch data

   Batch create expects an object with a key containing an array of items.

2. Step 2: Match correct JSON format

   {"items": [{"name": "item1"}, {"name": "item2"}]} is a JSON object with an array of objects, which is correct for batch create.

3. Final Answer:

   {"items": [{"name": "item1"}, {"name": "item2"}]} -> Option C

4. Quick Check:

   Batch create body = JSON object with items array [OK]

Hint: Batch create body is a JSON object with an array of items [OK]

Common Mistakes:

• Using duplicate keys in one object
• Sending a single object instead of an array
• Using incorrect JSON syntax

3. Given this batch create endpoint code snippet, what will be the response if one item is invalid?

POST /items/batch
Request body: [{"name": "item1"}, {"name": ""}]

Response: 400 Bad Request
{
  "error": "Validation failed",
  "details": [{"index": 1, "message": "Name cannot be empty"}]
}

medium

A. Server crashes due to invalid input

B. All items are created, ignoring the invalid one

C. Only the valid items are created, error ignored

D. No items are created, and error details are returned

Solution

1. Step 1: Understand validation behavior in batch create

   If any item is invalid, the server should reject the whole batch to keep data consistent.

2. Step 2: Analyze the response code and message

   Response 400 with error details means no items were created and client is informed.

3. Final Answer:

   No items are created, and error details are returned -> Option D

4. Quick Check:

   Validation failure returns 400 with errors [OK]

Hint: Validation errors cause full batch rejection [OK]

Common Mistakes:

• Assuming partial success without error
• Ignoring error details in response
• Expecting server to crash on bad input

4. You wrote a batch create endpoint but clients report that sending an empty array causes a 500 Internal Server Error. What is the likely fix?

medium

A. Add validation to return 400 Bad Request if array is empty

B. Change HTTP method from POST to GET

C. Remove JSON parsing from the endpoint

D. Allow empty arrays and return 204 No Content

Solution

1. Step 1: Identify cause of 500 error on empty input

   Server likely crashes because it does not handle empty arrays properly.

2. Step 2: Implement input validation for empty arrays

   Return 400 Bad Request to inform client that empty batch is invalid.

3. Final Answer:

   Add validation to return 400 Bad Request if array is empty -> Option A

4. Quick Check:

   Validate input to avoid server errors [OK]

Hint: Validate empty input to prevent server errors [OK]

Common Mistakes:

• Ignoring empty input causing crashes
• Changing HTTP method incorrectly
• Skipping JSON parsing

5. You want to design a batch create endpoint that returns the ID of each created item and reports errors per item without failing the whole batch. Which response design is best?

hard

A. {"results": [{"id": 1, "status": "created"}, {"error": "Invalid name", "status": "failed"}]}

B. {"error": "Batch failed", "status": 400}

C. [{"id": 1}, {"id": 2}]

D. {"message": "All items created successfully"}

Solution

1. Step 1: Understand partial success reporting

   To report success or failure per item, response must include status and details for each.

2. Step 2: Match response format to requirements

   {"results": [{"id": 1, "status": "created"}, {"error": "Invalid name", "status": "failed"}]} provides per-item status and error messages, allowing partial success.

3. Final Answer:

   {"results": [{"id": 1, "status": "created"}, {"error": "Invalid name", "status": "failed"}]} -> Option A

4. Quick Check:

   Per-item status in response enables partial success [OK]

Hint: Return per-item status and errors in response [OK]

Common Mistakes:

• Failing whole batch on one error
• Returning only success without error info
• Using generic messages without details