Postman

Official

Overview Schema Source Related Servers Discussions Admin

Create a collection response

createCollectionResponse

Create a saved response for an API request in a Postman collection, setting status, headers, body, and metadata for documentation or testing.

Instructions

Creates a request response in a collection. For a complete list of request body properties, refer to the Response entry in the Postman Collection Format documentation.

Note:

It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.

Input Schema

TableJSON Schema

Name	Required	Description
`url`	No	The associated request's URL.
`mime`	No	The response's MIME type.
`name`	No	The response's name. It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.
`text`	No	The raw text of the response body.
`time`	No	The time taken by the request to complete, in milliseconds.
`method`	No	The associated request's HTTP method.
`status`	No	The response's HTTP status text.
`cookies`	No	The response's cookie data.
`headers`	No	The response's headers.
`request`	Yes	The parent request's ID.
`dataMode`	No	The associated request body's data mode.
`language`	No	The response body's language type.
`dataOptions`	No	Additional options for the associated request body data.
`description`	No	The response's description.
`rawDataType`	No	The response's raw data type.
`rawModeData`	No	The associated request body's raw mode data.
`collectionId`	Yes	The collection's ID.
`responseCode`	No	The response's HTTP response code information.
`requestObject`	No	A JSON-stringified representation of the associated request.

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv2.12.3Sep 9, 2026

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 associated request body data."

changedInput schema / properties / headers / description

Previous value: -"A list of headers."New value: +"The response's headers."

changedInput schema / properties / method / description

Previous value: -"The request's HTTP method."New value: +"The associated request's HTTP method."

Changed19 schema fields changedv2.8.7May 4, 2026

addedInput schema / properties / cookies

Added value: +{
+  "description": "The response's cookie data.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedInput schema / properties / dataMode

Added value: +{
+  "description": "The associated request body's data mode.",
+  "enum": [
+    "raw",
+    "urlencoded",
+    "formdata",
+    "binary",
+    "graphql"
+  ],
+  "type": "string"
+}

addedInput schema / properties / dataOptions

Added value: +{
+  "anyOf": [
+    {
+      "additionalProperties": false,
+      "properties": {
+        "binary": {
+          "additionalProperties": {},
+          "description": "Options for the `binary` data mode.",
+          "type": "object"
+        },
+        "graphql": {
+          "additionalProperties": {},
+          "description": "Options for the `graphql` data mode.",
+          "type": "object"
+        },
+        "params": {
+          "additionalProperties": {},
+          "description": "Options for the `params` data mode.",
+          "type": "object"
+        },
+        "raw": {
+          "additionalProperties": false,
+          "description": "Options for the `raw` data mode.",
+          "properties": {
+            "language": {
+              "description": "The raw mode data's language type.",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "urlencoded": {
+          "additionalProperties": {},
+          "description": "Options for the `urlencoded` data mode.",
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Additional configurations and options set for the request body's various data modes."
+}

addedInput schema / properties / description

Added value: +{
+  "description": "The response's description.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedInput schema / properties / headers

Added value: +{
+  "description": "A list of headers.",
+  "items": {
+    "additionalProperties": false,
+    "description": "Information about the header.",
+    "properties": {
+      "description": {
+        "description": "The header's description.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "key": {
+        "description": "The header's key, such as `Content-Type` or `X-Custom-Header`.",
+        "type": "string"
+      },
+      "value": {
+        "description": "The header key's value.",
+        "type": "string"
+      }
+    },
+    "required": [
+      "key",
+      "value"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

addedInput schema / properties / language

Added value: +{
+  "description": "The response body's language type.",
+  "type": "string"
+}

addedInput schema / properties / method

Added value: +{
+  "description": "The request's HTTP method.",
+  "enum": [
+    "GET",
+    "PUT",
+    "POST",
+    "PATCH",
+    "DELETE",
+    "COPY",
+    "HEAD",
+    "OPTIONS",
+    "LINK",
+    "UNLINK",
+    "PURGE",
+    "LOCK",
+    "UNLOCK",
+    "PROPFIND",
+    "VIEW"
+  ],
+  "type": "string"
+}

addedInput schema / properties / mime

Added value: +{
+  "description": "The response's MIME type.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedInput schema / properties / rawDataType

Added value: +{
+  "description": "The response's raw data type.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedInput schema / properties / rawModeData

Added value: +{
+  "description": "The associated request body's raw mode data.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedInput schema / properties / request

Added value: +{
+  "description": "The parent request's ID.",
+  "type": "string"
+}

removedInput schema / properties / requestId

Removed value: -{
-  "description": "The parent request's ID.",
-  "type": "string"
-}

addedInput schema / properties / requestObject

Added value: +{
+  "description": "A JSON-stringified representation of the associated request.",
+  "type": "string"
+}

addedInput schema / properties / responseCode

Added value: +{
+  "additionalProperties": false,
+  "description": "The response's HTTP response code information.",
+  "properties": {
+    "code": {
+      "description": "The response's HTTP response status code.",
+      "type": "number"
+    },
+    "name": {
+      "description": "The name of the status code.",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

addedInput schema / properties / status

Added value: +{
+  "description": "The response's HTTP status text.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedInput schema / properties / text

Added value: +{
+  "description": "The raw text of the response body.",
+  "type": "string"
+}

addedInput schema / properties / time

Added value: +{
+  "description": "The time taken by the request to complete, in milliseconds.",
+  "type": "string"
+}

addedInput schema / properties / url

Added value: +{
+  "description": "The associated request's URL.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

changedInput schema / required

Previous value: -[
-  "collectionId",
-  "requestId"
-]New value: +[
+  "collectionId",
+  "request"
+]

First observedJan 14, 2026

TDQS

B3.2/5.0

Behavior3/5

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

Annotations already declare this is a mutating (readOnlyHint=false), non-idempotent, non-destructive, open-world operation, so the safety profile is covered. The description adds one genuine behavioral consequence — omitting name yields a blank-named response — but says nothing about permissions, whether re-calling duplicates the response, or what happens to the parent request.

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?

Purpose is front-loaded, followed by a doc pointer and a short note; three compact chunks with no filler. The external-documentation redirect is slightly evasive but it keeps the definition tight.

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

Completeness3/5

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

For a 19-parameter tool with nested objects and no output schema, the description delegates the bulk of body semantics to an external Postman schema link. Schema coverage compensates for the parameter side, but the description never indicates what the call returns (created object, ID, status), which an agent calling a create endpoint would want.

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 description coverage is 100%, with all 19 properties documented including enums and nested header objects, so the baseline is 3. The description's name-property note merely repeats the identical text already present on the name field and adds no syntax or format detail beyond the schema.

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?

States a clear verb and resource: 'Creates a request response in a collection.' An agent understands it persists a saved response example. However, it never distinguishes itself from the very similarly named sibling createCollectionRequest, and the phrase 'request response' is ambiguous enough that an agent could confuse the two.

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

Usage Guidelines2/5

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

No guidance on when to create a response versus creating a request (createCollectionRequest) or a collection (createCollection), and no stated prerequisites such as whether the parent request must already exist. The only actionable advice concerns the name property, which is parameter-level, not usage-level.

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

Create a collection response

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools