Skip to content
Postman API Testing Tips

How To Use Put In Postman

API Testing Blog

Mastering PUT Requests in Postman for API Testing

Postman is a powerful tool for testing APIs, and PUT requests are an essential part of many API workflows. In this guide, we’ll delve into how to leverage PUT requests effectively in Postman for comprehensive API testing.

Understanding the PUT Method

The PUT method is used to update or replace an existing resource on a server. It’s crucial to understand that a PUT request completely replaces the existing resource with the data provided.

Let’s illustrate this with a practical example: imagine a “users” API endpoint. If you want to modify a user’s email address, you’d send a PUT request to the /users/{userId} endpoint, replacing the existing email with the new one.

Setting up a PUT Request in Postman

  1. Create a Request: Open Postman and click on “New” to create a new request.
  2. Select Method: Choose “PUT” from the dropdown menu.
  3. Enter URL: Input the API endpoint you want to target. For example, if you’re updating a user’s details, you might use a URL like https://api.example.com/users/123.
  4. Add Headers: Headers provide additional information about the request. Common headers for PUT requests include:
    • Content-Type: Specifies the data format of the request body (e.g., application/json).
    • Authorization: Provides authentication information if necessary.
  5. Construct Body: This is where you define the new data that will replace the existing resource. You can use different formats for the body, such as JSON, XML, or form data. In Postman, you can easily switch between these formats using the “Body” tab.

Practical Example: Updating User Information

Let’s update a user’s name and email in a hypothetical API using Postman.

  1. Request:
    • URL: https://api.example.com/users/123
    • Method: PUT
    • Headers:
      • Content-Type: application/json
  2. Body (JSON):
{
  "name": "Updated User Name",
  "email": "updated.user@example.com"
}

  1. Send the Request: Click on “Send” to execute the PUT request.

  2. Response: Postman will display the response from the API, including a status code and the updated resource data.

How to Use Put in Postman with Variables

Postman allows you to use variables, making your requests dynamic and reusable. This is particularly useful when testing multiple scenarios or working with different data sets.

Here’s how to use variables with PUT requests:

  1. Define Variables: Go to the “Environment” tab in Postman. Click on “Add” to create a new variable. You can give it a name and assign a value, for example:

    • Variable Name: userId
    • Value: 123

  2. Utilize Variables in the Request: In the URL or body of the request, use the syntax {{variableName}} to include the variable.

    • URL: https://api.example.com/users/{{userId}}

  3. Modify Variable Values: You can easily update variable values within the “Environment” tab, allowing you to test different user IDs or data with the same request setup.

Using PUT for Partial Updates

Sometimes, you might only want to update specific fields within a resource without replacing the entire entity. Most APIs support partial updates using the PUT method, allowing you to send only the fields you want to modify.

Here’s how to achieve partial updates:

  1. Request:
    • URL: https://api.example.com/users/123
    • Method: PUT
    • Headers:
      • Content-Type: application/json
  2. Body (JSON):
{
  "email": "updated.user@example.com"
}

Notice that we only include the “email” field in the request body. This will update only the email field of the user with ID 123 while preserving the other existing data.

Testing PUT Requests with Assertions

Postman’s built-in assertions allow you to verify that the PUT request was successful and that the resource was updated as expected.

  1. Add Assertions: Go to the “Tests” tab in Postman and add assertions.

  2. Common Assertions for PUT Requests:

    • Verification Status Code: pm.test("Status code is 200", function () { pm.response.to.have.status(200); });
    • Verification of Specific Data: pm.test("Name is updated", function () { pm.expect(pm.response.json().name).to.be.equal("Updated User Name"); });

  3. Execute and Analyze: Send the PUT request and review the results in the “Test Results” section. Successful assertions will turn green, indicating a successful update.

Conclusion

Mastering PUT requests in Postman is paramount for API testing. By using the PUT method correctly, you can effectively update existing resources, test for partial updates, and leverage variables for dynamic testing. Remember to use assertions to rigorously validate the outcomes of your PUT requests. With these techniques, you’ll be well-equipped to conduct comprehensive and efficient API testing using Postman.

API Testing Blog