PUT request in Postman - Framework Patterns

Framework Mode - PUT request

Folder Structure for Postman PUT Request Tests

Postman-Tests/
├── Collections/
│   └── UserManagement.postman_collection.json
├── Environments/
│   ├── Dev.postman_environment.json
│   ├── Staging.postman_environment.json
│   └── Prod.postman_environment.json
├── Scripts/
│   ├── PreRequest/
│   │   └── authSetup.js
│   └── Tests/
│       └── putUserTests.js
└── README.md

Test Framework Layers in Postman for PUT Requests

• Collections: Group of API requests including PUT requests organized by feature or resource.
• Environments: Variables for different deployment stages (Dev, Staging, Prod) like base URLs and tokens.
• Pre-request Scripts: JavaScript code that runs before the PUT request to set headers or authentication tokens.
• Tests Scripts: JavaScript assertions that validate the PUT response status, body, and headers.
• Documentation: README or notes explaining test purpose and usage.

Configuration Patterns for Postman PUT Requests

• Environment Variables: Store base URLs, API keys, and tokens per environment to switch easily.
• Global Variables: Use for values shared across collections like common user IDs.
• Authorization Setup: Use pre-request scripts to dynamically generate or refresh tokens before PUT requests.
• Data Files: Use CSV or JSON files for data-driven PUT requests to update multiple records.
• Collection Variables: Define variables scoped to the collection for consistent headers or payload templates.

Test Reporting and CI/CD Integration

• Postman Test Results: View pass/fail results in the Postman Test Results tab after running PUT requests.
• Newman CLI: Run collections from command line with Newman to integrate with CI/CD pipelines.
• CI/CD Integration: Use Newman in Jenkins, GitHub Actions, or GitLab CI to run PUT request tests automatically on code changes.
• Report Formats: Generate HTML or JSON reports from Newman runs for easy sharing and analysis.
• Alerts: Configure pipeline to notify team on PUT request test failures via email or chat tools.

Best Practices for Postman PUT Request Framework

• Use Environment Variables: Avoid hardcoding URLs or tokens to keep tests flexible and secure.
• Validate Response Thoroughly: Check status code, response body fields, and headers after PUT requests.
• Use Pre-request Scripts: Automate token refresh or dynamic data setup before PUT requests.
• Data-driven Testing: Use external data files to test multiple update scenarios with PUT requests.
• Organize Collections Clearly: Group PUT requests logically by resource or feature for easy maintenance.

Self Check Question

Where in this Postman framework structure would you add a new PUT request to update a user's email address?

Key Result

Organize Postman PUT request tests using collections, environment variables, pre-request scripts, and Newman for CI integration.

Practice

1. What is the main purpose of a PUT request in Postman?

easy

A. To update or replace an existing resource on the server

B. To retrieve data from the server

C. To delete a resource from the server

D. To create a new resource without replacing existing data

Solution

1. Step 1: Understand HTTP methods

   PUT is used to update or replace existing data, unlike GET which retrieves data or DELETE which removes data.

2. Step 2: Match PUT request purpose

   PUT requires sending the full new data to replace the existing resource, so it updates or replaces it.

3. Final Answer:

   To update or replace an existing resource on the server -> Option A

4. Quick Check:

   PUT updates/replaces resource = A [OK]

Hint: PUT replaces full resource data, not partial updates [OK]

Common Mistakes:

• Confusing PUT with GET or POST
• Thinking PUT creates new resources only
• Assuming PUT partially updates data

2. Which of the following is the correct way to set up a PUT request body in Postman to update a user's name to "Alice"?

easy

A. { name = "Alice" }

B. [ "name": "Alice" ]

C. "name": "Alice"

D. { "name": "Alice" }

Solution

1. Step 1: Identify correct JSON syntax

   JSON objects use curly braces with key-value pairs in double quotes and colon separators.

2. Step 2: Validate syntax of options

   Only { "name": "Alice" } is valid JSON. The others have syntax errors like using = instead of :, square brackets, or incomplete structure.

3. Final Answer:

   { "name": "Alice" } -> Option D

4. Quick Check:

   Valid JSON body = D [OK]

Hint: Use curly braces and double quotes for JSON body [OK]

Common Mistakes:

• Using square brackets instead of braces
• Missing quotes around keys or values
• Using equals sign instead of colon

3. Given this PUT request in Postman to update a product's price:

{
  "id": 101,
  "name": "Coffee Mug",
  "price": 12.99
}

If the server replaces the entire product resource with this data, what will be the product's name after the update?

medium

A. null

B. Original name before update

C. Coffee Mug

D. Error: Missing fields

Solution

1. Step 1: Understand PUT replaces full resource

   The server replaces the entire product data with the provided JSON, so all fields sent become the new state.

2. Step 2: Check the name field in the request body

   The name is "Coffee Mug" in the JSON, so after update, the product's name will be "Coffee Mug".

3. Final Answer:

   Coffee Mug -> Option C

4. Quick Check:

   PUT replaces resource fully = Coffee Mug [OK]

Hint: PUT replaces all fields sent, so name updates to given value [OK]

Common Mistakes:

• Assuming PUT only updates changed fields
• Thinking missing fields stay unchanged
• Expecting error if some fields are missing

4. You send a PUT request in Postman but receive a 400 Bad Request error. Which of these is the most likely cause?

medium

A. The server does not support PUT requests

B. The request body is missing required fields or has invalid JSON

C. The URL is incorrect but the body is fine

D. The GET method was used instead of PUT

Solution

1. Step 1: Understand 400 Bad Request meaning

   400 error means the server could not understand the request due to invalid syntax or missing data.

2. Step 2: Analyze causes for 400 in PUT requests

   Invalid JSON or missing required fields in the body commonly cause 400 errors for PUT requests.

3. Final Answer:

   The request body is missing required fields or has invalid JSON -> Option B

4. Quick Check:

   400 error = invalid request body [OK]

Hint: Check JSON syntax and required fields for 400 errors [OK]

Common Mistakes:

• Confusing 400 with 404 Not Found
• Assuming server disallows PUT causes 400
• Mixing up HTTP methods in error cause

5. You want to update a user's profile with a PUT request in Postman. The user has fields: id, name, email, and phone. You only want to change the phone number. What is the best practice to avoid accidentally deleting other fields?

hard

A. Include all fields with current values, changing only the phone number in the PUT body

B. Send only the phone field in the PUT body

C. Use a GET request to update the phone number

D. Send an empty body with the PUT request

Solution

1. Step 1: Recall PUT replaces entire resource

   PUT replaces the whole resource with the data sent, so missing fields will be removed.

2. Step 2: Include all fields to preserve data

   To avoid deleting fields, send all current fields with updated phone number in the PUT body.

3. Final Answer:

   Include all fields with current values, changing only the phone number in the PUT body -> Option A

4. Quick Check:

   PUT replaces full data, so send all fields [OK]

Hint: Send full resource data in PUT to avoid data loss [OK]

Common Mistakes:

• Sending partial data with PUT causing data loss
• Using GET to update data
• Sending empty body expecting no changes