PUT for full replacement in Rest API

Introduction

PUT is used to completely replace a resource on a server with new data. It updates everything about that resource.

You want to update all details of a user profile at once.

Replacing a whole document or file on a server with a new version.

Updating a product's full information in an online store.

Changing all settings of a device stored on a server.

Syntax

Rest API

PUT /resource/{id} HTTP/1.1
Host: example.com
Content-Type: application/json

{
  "field1": "new value",
  "field2": "new value"
}

PUT replaces the entire resource at the given URL.

If the resource does not exist, PUT can create it.

Examples

This replaces the user with ID 123 completely with the new name and email.

Rest API

PUT /users/123 HTTP/1.1
Host: api.example.com
Content-Type: application/json

{
  "name": "Alice",
  "email": "[e-mail]"
}

This replaces all details of product 456 with new values.

Rest API

PUT /products/456 HTTP/1.1
Host: api.example.com
Content-Type: application/json

{
  "name": "New Product",
  "price": 19.99,
  "stock": 100
}

Sample Program

This Python program sends a PUT request to replace the post with ID 1 on a test API. It updates the title and body fully.

Rest API

import requests

url = 'https://jsonplaceholder.typicode.com/posts/1'

new_data = {
    "userId": 1,
    "id": 1,
    "title": "Updated Title",
    "body": "This is the updated body of the post."
}

response = requests.put(url, json=new_data)

print('Status code:', response.status_code)
print('Response JSON:', response.json())

Important Notes

PUT replaces the entire resource, so missing fields may be removed.

Use PATCH if you want to update only some fields without replacing everything.

Always send the full resource data with PUT to avoid losing information.

Summary

PUT fully replaces a resource at the given URL.

It can create the resource if it does not exist.

Use PUT when you want to update all fields of a resource at once.

Practice

1. What does the HTTP PUT method do when used on a REST API resource URL?

easy

A. Retrieves the resource data from the URL

B. Partially updates the resource fields at the URL

C. Fully replaces the resource at the URL with the provided data

D. Deletes the resource at the URL

Solution

1. Step 1: Understand PUT method purpose

   PUT is designed to replace the entire resource at the given URL with the data sent in the request.

2. Step 2: Compare with other methods

   Unlike PATCH which updates partially, PUT replaces fully. GET retrieves, DELETE removes.

3. Final Answer:

   Fully replaces the resource at the URL with the provided data -> Option C

4. Quick Check:

   PUT = full replacement [OK]

Hint: PUT replaces entire resource, not partial update [OK]

Common Mistakes:

• Confusing PUT with PATCH partial update
• Thinking PUT deletes resource
• Assuming PUT only retrieves data

2. Which of the following is the correct HTTP method and usage to fully replace a resource at URL /users/123 with new data in JSON format?

easy

A. POST /users/123 with JSON body

B. PUT /users/123 with JSON body

C. PATCH /users/123 with JSON body

D. GET /users/123 with JSON body

Solution

1. Step 1: Identify method for full replacement

   PUT is the HTTP method used to fully replace a resource at a specific URL.

2. Step 2: Match method with URL and body

   PUT /users/123 with JSON body replaces the user data fully. POST is for creation, PATCH partial update, GET retrieves.

3. Final Answer:

   PUT /users/123 with JSON body -> Option B

4. Quick Check:

   PUT + URL + JSON = full replace [OK]

Hint: Use PUT with URL and full JSON body to replace resource [OK]

Common Mistakes:

• Using POST instead of PUT for replacement
• Using PATCH for full replacement
• Sending body with GET request

3. Given a REST API with a user resource at /users/42 initially having data {"name": "Alice", "age": 30}, what will be the resource data after this PUT request?

PUT /users/42
{"name": "Bob"}

medium

A. {"name": "Bob"}

B. {"name": "Bob", "age": 30}

C. {"age": 30}

D. Resource deleted

Solution

1. Step 1: Understand PUT replaces entire resource

   The PUT request replaces the whole resource data with the new JSON body, removing any fields not included.

2. Step 2: Apply replacement to given data

   Original data had name and age, but PUT body only has name "Bob", so age is removed.

3. Final Answer:

   {"name": "Bob"} -> Option A

4. Quick Check:

   PUT replaces all fields, missing fields removed [OK]

Hint: PUT replaces all fields; missing fields are removed [OK]

Common Mistakes:

• Assuming PUT merges fields like PATCH
• Expecting old fields to remain if not sent
• Thinking PUT deletes resource

4. You wrote this PUT request to update a resource:

PUT /items/10
{"price": 100}

But after sending, the resource lost all other fields except price. How can you fix this to keep other fields intact?

medium

A. Use GET method instead

B. Add missing fields to the PUT JSON body

C. Send an empty body with PUT

D. Change PUT to PATCH to update partially

Solution

1. Step 1: Identify cause of lost fields

   PUT replaces the entire resource, so missing fields in body are removed.

2. Step 2: Choose method to update partially

   PATCH updates only specified fields, keeping others intact.

3. Final Answer:

   Change PUT to PATCH to update partially -> Option D

4. Quick Check:

   PATCH = partial update, keeps other fields [OK]

Hint: Use PATCH for partial update, PUT replaces all [OK]

Common Mistakes:

• Trying to fix by adding missing fields manually
• Sending empty body with PUT
• Using GET to update resource

5. You want to update a user resource at /users/77 with new data {"name": "Eve", "age": 28}. The resource may or may not exist. Which is the best approach using PUT to ensure the resource is created if missing or fully replaced if exists?

hard

A. Send a PUT request with full user data to /users/77

B. Send a POST request to /users with partial data

C. Send a PATCH request to /users/77 with partial data

D. Send a GET request to /users/77 before updating

Solution

1. Step 1: Understand PUT behavior for create or replace

   PUT can create the resource if it does not exist, or fully replace it if it does.

2. Step 2: Apply PUT with full data to target URL

   Sending PUT with full user data to /users/77 ensures creation or full replacement.

3. Final Answer:

   Send a PUT request with full user data to /users/77 -> Option A

4. Quick Check:

   PUT = create or replace resource fully [OK]

Hint: PUT creates or replaces resource at URL with full data [OK]

Common Mistakes:

• Using POST which creates new resource with new ID
• Using PATCH which only updates existing resource partially
• Using GET before update unnecessarily