Batch update patterns in Rest API

Introduction

Batch update patterns let you change many items at once with one request. This saves time and makes your app faster.

You want to update multiple user profiles in one go.

You need to change the status of many orders at once.

You want to apply the same change to many records quickly.

You want to reduce the number of requests to the server.

You want to keep your app responsive when updating many items.

Syntax

Rest API

PATCH /items
Content-Type: application/json

{
  "updates": [
    {"id": 1, "field": "value1"},
    {"id": 2, "field": "value2"}
  ]
}

Use HTTP PATCH method for partial updates.

Send an array of update objects inside the request body.

Examples

Update emails of two users in one request.

Rest API

PATCH /users
Content-Type: application/json

{
  "updates": [
    {"id": 101, "email": "[e-mail]"},
    {"id": 102, "email": "[e-mail]"}
  ]
}

Change status of multiple orders to 'shipped'.

Rest API

PATCH /orders
Content-Type: application/json

{
  "updates": [
    {"id": 201, "status": "shipped"},
    {"id": 202, "status": "shipped"}
  ]
}

Sample Program

This Python code sends a batch update request to change names of two items. It prints if the update worked or failed.

Rest API

import requests

url = 'https://api.example.com/items'

batch_update = {
    "updates": [
        {"id": 1, "name": "Item One Updated"},
        {"id": 2, "name": "Item Two Updated"}
    ]
}

response = requests.patch(url, json=batch_update)

if response.status_code == 200:
    print('Batch update successful')
else:
    print('Batch update failed')

Important Notes

Make sure your API supports batch updates before using this pattern.

Validate each item in the batch to avoid partial failures.

Use proper HTTP status codes to indicate success or errors.

Summary

Batch update patterns let you update many items with one request.

This saves time and reduces server load.

Use PATCH method and send an array of updates in JSON format.