Skip to main content
Glama
postmanlabs

Postman

Official
by postmanlabs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Update a request

updateCollectionRequest
Idempotent

Update a request in a Postman collection by supplying request and collection IDs, then specify only the fields to change. Acts like a PATCH, modifying just the provided properties.

Instructions

Updates a request in a collection. For a complete list of properties, refer to the Request entry in the Postman Collection Format documentation.

Note:

  • You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection(`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

  • This endpoint does not support changing the folder of a request.

  • This endpoint acts like a PATCH method. It only updates the values that you pass in the request body.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoThe request's URL.
authNoThe request's authorization settings.
dataNoThe request body's form or urlencoded data.
nameNoThe request's name.
eventsNoThe request's pre-request and test scripts.
methodNoThe request's HTTP method.
dataModeNoThe request body's data mode.
requestIdYesThe request's ID.
headerDataNoThe request's headers.
dataOptionsNoAdditional options for the request body data.
descriptionNoThe request's description.
queryParamsNoThe request's query parameters.
rawModeDataNoThe request body's raw mode data.
collectionIdYesThe collection's ID.
graphqlModeDataNoThe request body's GraphQL mode data.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.12.3
    • changedInput schema / properties / auth / description
      Previous value: -"The request's authentication information."New value: +"The request's authorization settings."
    • changedInput schema / properties / data / description
      Previous value: -"The request body's form data."New value: +"The request body's form or urlencoded data."
    • changedInput schema / properties / dataOptions / description
      Previous value: -"Additional configurations and options set for the request body's various data modes."New value: +"Additional options for the request body data."
    • changedInput schema / properties / events / description
      Previous value: -"A list of scripts configured to run when specific events occur."New value: +"The request's pre-request and test scripts."
  2. Changed3 schema fields changedv2.12.0
    • removedInput schema / properties / events / anyOf
      Removed value: -[
-  {
-    "items": {
-      "additionalProperties": false,
-      "properties": {
-        "listen": {
-          "description": "The event type.",
-          "enum": [
-            "test",
-            "prerequest"
-          ],
-          "type": "string"
-        },
-        "script": {
-          "additionalProperties": false,
-          "description": "Information about the Javascript code that can be used to to perform setup or teardown operations in a response.",
-          "properties": {
-            "exec": {
-              "description": "A list of script strings, where each line represents a line of code. Separate lines makes it easy to track script changes.",
-              "items": {
-                "type": [
-                  "string",
-                  "null"
-                ]
-              },
-              "type": "array"
-            },
-            "id": {
-              "description": "The script's ID.",
-              "type": "string"
-            },
-            "type": {
-              "description": "The type of script. For example, `text/javascript`.",
-              "type": "string"
-            }
-          },
-          "type": "object"
-        }
-      },
-      "type": "object"
-    },
-    "type": "array"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedInput schema / properties / events / items
      Added value: +{
+  "additionalProperties": false,
+  "properties": {
+    "listen": {
+      "description": "The event type.",
+      "enum": [
+        "test",
+        "prerequest"
+      ],
+      "type": "string"
+    },
+    "script": {
+      "additionalProperties": false,
+      "description": "Information about the Javascript code that can be used to to perform setup or teardown operations in a response.",
+      "properties": {
+        "exec": {
+          "description": "A list of script strings, where each line represents a line of code. Separate lines makes it easy to track script changes.",
+          "items": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "type": "array"
+        },
+        "id": {
+          "description": "The script's ID.",
+          "type": "string"
+        },
+        "type": {
+          "description": "The type of script. For example, `text/javascript`.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
    • addedInput schema / properties / events / type
      Added value: +"array"
  3. Addedv2.8.7

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description clearly explains the PATCH-like behavior, which is critical for understanding that omitted fields are not reset. It also states the limitation about folder changes. Annotations declare idempotentHint=true (consistent with PATCH) and destructiveHint=false; the description aligns well, adding behavioral nuance beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and structured: a clear primary sentence followed by a list of notes. It front-loads the core action and then presents important caveats in an easy-to-parse list. No unnecessary fluff, though the note about the collection ID could be more prominent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex tool with 15 parameters, the description provides complete, necessary context: it clarifies the ID requirement, PATCH semantics, and the folder limitation. Since there is no output schema, the description doesn't need to explain return values, but it covers the main operational traps, making it sufficient for an agent to call correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already defines every parameter. The description adds context for specific parameters like collectionId (explaining the ID vs UID distinction), but does not elaborate on the update semantics for each field (e.g., how auth or headers are handled). Thus, it adds some value beyond schema, but the schema carries most of the weight.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Updates a request in a collection', clearly identifying the verb (update) and the resource (request within a collection). It distinguishes itself from createCollectionRequest and other update tools, but does not explicitly name a sibling or contrast with them. The title aligns well.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides key usage guidance: it specifies that collectionId must be the collection ID not the collection UID (with an illustrative example), and notes that folder changes are not supported, and that it acts as a PATCH (only updates provided values). However, it does not explicitly say when not to use this tool versus alternatives like createCollectionRequest or putCollection, but the guidance on scope is useful.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools