PUT Request Examples Using REST API

Explore practical examples of PUT requests using REST API to enhance your understanding of API interactions.
By Jamie

Understanding PUT Requests in REST API

In RESTful APIs, the PUT method is used to update existing resources or create new ones at a specific URI. This method is idempotent, meaning that calling it multiple times will not change the result beyond the initial application. Below are three practical examples of PUT requests that illustrate their usage in different contexts.

Example 1: Updating User Profile Information

Context: In a user management system, you may need to update a user’s profile details, such as their email address or display name. This example demonstrates how to send a PUT request to update a user’s information.

PUT /api/users/123
Content-Type: application/json

{
  "displayName": "Jane Doe",
  "email": "jane.doe@example.com"
}

In this example, we are updating the user with ID 123. We specify the new display name and email address in the request body as a JSON object. This request will replace the existing user details with the new information provided.

Notes: Ensure that the user ID in the URI corresponds to an existing user. If the user does not exist, the server may respond with a 404 Not Found error.

Example 2: Modifying Product Information in an E-commerce System

Context: When managing an e-commerce platform, you might need to update product details such as price or availability. This example shows how to perform a PUT request to modify a product’s information.

PUT /api/products/456
Content-Type: application/json

{
  "name": "Wireless Headphones",
  "price": 89.99,
  "inStock": true
}

Here, we are updating the product with ID 456. The name, price, and stock status are included in the JSON body. This request will update the existing product’s details with the new values provided.

Notes: Be cautious with the data types; for example, the price should be a numeric value. If the product ID does not exist, the server may return a 404 error.

Example 3: Updating a Task in a Task Management Application

Context: In a task management application, users can update the status or details of their tasks. This example demonstrates how to send a PUT request to update a specific task.

PUT /api/tasks/789
Content-Type: application/json

{
  "title": "Complete API Documentation",
  "status": "completed",
  "dueDate": "2023-10-15"
}

In this case, we are updating the task with ID 789. We change the title, set the status to completed, and update the due date. The request will replace the existing task details with the information provided in the request body.

Notes: When updating the status of a task, ensure that the new status is valid according to the application’s defined statuses, such as ‘pending’, ‘in-progress’, or ‘completed’.

These examples of PUT request example using REST API illustrate how to effectively update resources in various applications. Understanding these practical applications can enhance your ability to work with RESTful APIs.