programming

Differences Between Put and Patch in Rest API & When to Use Them

In this blog post, we’ll learn about the differences between PUT & PATCH and when to use each method. But before we do so, let’s take a step back and understand some important concepts such as HTTP, HTTP methods, and RESTful APIs.

What is HTTP?

HTTP stands for Hypertext Transfer Protocol. It is a set of rules for encoding and transporting information between a client and a server over the Internet.

When you open a website on your browser, it sends an HTTP request to the server where the website is hosted. The server then sends back an HTTP response with the website content, such as text, images, and videos. HTTP is responsible for structuring these requests and responses in a way that both the client (your browser) and the server can understand.

HTTP Methods

HTTP defines a number of different methods that can be used to request or send information to a server. These methods are often referred to as HTTP verbs or HTTP methods. The five primary methods are GET, POST, PUT, PATCH, and DELETE.

What is REST API?

In the context of web development, HTTP is important because it is the foundation of RESTful APIs. RESTful APIs are a way for different software systems to communicate with each other.

RESTful APIs use HTTP methods, such as GET, POST, PUT, PATCH, and DELETE, to specify what action should be taken on a resource.

Difference Between PUT & PATCH

PUT and PATCH are two methods that are often used for updating resources on the server. However, they differ in their approach.

PUT

PUT is used to replace an existing resource with a completely new one. In other words, if you send a PUT request to update a resource, the server will completely replace the existing resource with the new one.

For example, let's say you have a user profile with fields for name, email, and password. If you use PUT to update the profile, you’ll have to send the updated values for all three fields: name, email, and password.

PATCH

On the other hand, PATCH is used to make a partial update to an existing resource. In other words, if you send a PATCH request to update a resource, the server will only update the specified fields in the existing resource.

So, if you only want to update the email field only, you would send just that field with the new value. The server then applies the changes you specified and leaves the rest of the resource unchanged.

The following table captures the main differences between PUT and PATCH:

	PUT	PATCH
Usage	Updates all the fields of a resource. Replaces the entire resource with the new data provided.	Partially updates a resource. Applies changes to specific fields.
Required fields	Requires sending the entire updated resource.	Allows sending only changes or updates.
Response	The complete updated resource.	The complete updated resource.

When to Use Put and When to Use Patch

In general, if you want to update a resource completely, you should use PUT. If you want to update only a part of a resource, you should use PATCH.

To make this concept clearer, let’s dive into a practical example. For our example, we’ll use the following:

JSONPlaceholder: It’s a fake REST API. Fake REST APIs are used for testing and prototyping purposes without messing with real production APIs and databases.
Postman: It’s an API platform for working with APIs. We’ll use Postman to create and send API requests to JSONPlaceholder, the fake REST API.

To follow along with this example, you must have Postman installed. If not, you can download Postman from the link Download Postman.

The JSONPlaceholder fake API comes with many resources. We’ll work with the todos resource. To see what a "todo" resource looks like, go to https://jsonplaceholder.typicode.com/todos/1 in your browser and you’ll see the following output:

As you can see in the screenshot above, a todo resource has four fields: userId, id, title, and completed.

Note: In the URL https://jsonplaceholder.typicode.com/todos/1, /1 refers to the id field of the "todo" resource.

Using PATCH

Let’s say we want to update the completed field from false to true for the "todo" resource with an id of 1. As we want to update only one field out of four fields (in other words, we want to update only a part of a complete resource), we’ll send a PATCH request. Let’s do that now using Postman.

In Postman, complete the following steps, as highlighted in the screenshot below:

Select PATCH
Mention the API endpoint, https://jsonplaceholder.typicode.com/todos/1.
Select Body
Select raw
Select JSON from the dropdown. We’ll be sending the data to the API endpoint in JSON format.
Write the JSON object: {"completed" : true} in the section as highlighted below. This is the data we’ll send to the JSONPlaceholder API.

Finally, click on SEND. Upon sending the request, you’ll get a response as shown below:

As you can see, the server has returned the complete resource, where the value of the completed field has been updated from false to true, as requested. Also, we have an HTTP status response code of 200, indicating that the update was successful.

Next, let’s explore the PUT method.

Using PUT

As discussed earlier, PUT requires sending the complete resource we want to update, including all the updated fields. Let's say we want to update all the fields of the "todo" resource with an id of 1.

On the same Postman request we have used with PATCH, make the following changes:

Choose the PUT method from the dropdown.
In the "Body" section, write the following JSON object:

{
"id":1,
"userId": 1,
"title": "Learn Linux",
"completed": true
}

Note that you can change the values of these fields - id, userId, title, and completed - to anything you like.

Now, click on SEND.

As you can see below, the server has responded with the updated output and a status code of 200, indicating a successful update.

Note: Keep in mind that the updates we made to the "todo" resource are not persisted in "JSONPlaceholder" as it's a FAKE REST API. It only behaves as if the resource has been updated. With this understanding, you now have the knowledge to effectively work with PUT and PATCH requests in your API development workflow.

Embark on a DevOps journey with our DevOps Learning Path:

Conclusion

I hope that this blog post has clarified the differences between PUT and PATCH and has provided you with a better understanding of when to use each method.

Interested in learning more about programming? Check out the programming learning path from KodeKloud.

Hemanta Sundaray

Apr 26, 2023 • 6 min read