createCollectionResponse
Create a response for a request within a Postman collection by providing status code, headers, body, and other response details.
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 | Default |
|---|---|---|---|
| collectionId | Yes | The collection's ID. | |
| request | Yes | The parent request's ID. | |
| 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. | |
| description | No | The response's description. | |
| url | No | The associated request's URL. | |
| method | No | The request's HTTP method. | |
| headers | No | A list of headers. | |
| dataMode | No | The associated request body's data mode. | |
| rawModeData | No | The associated request body's raw mode data. | |
| dataOptions | No | Additional configurations and options set for the request body's various data modes. | |
| responseCode | No | The response's HTTP response code information. | |
| status | No | The response's HTTP status text. | |
| time | No | The time taken by the request to complete, in milliseconds. | |
| cookies | No | The response's cookie data. | |
| mime | No | The response's MIME type. | |
| text | No | The raw text of the response body. | |
| language | No | The response body's language type. | |
| rawDataType | No | The response's raw data type. | |
| requestObject | No | A JSON-stringified representation of the associated request. |