Create a request
createCollectionRequestCreate an API request inside a Postman collection. Specify URL, method, headers, authentication, and body to add a fully configured request.
Instructions
Creates a request in a collection. For a complete list of properties, refer to the Request 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 request with a blank name.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The request's URL. | |
| auth | No | The request's authorization settings. | |
| data | No | The request body's form or urlencoded data. | |
| name | No | The request'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 request with a blank name. | |
| events | No | The request's pre-request and test scripts. | |
| folder | No | The folder ID in which to create the request. By default, the system creates the request at the collection level. | |
| method | No | The request's HTTP method. | |
| dataMode | No | The request body's data mode. | |
| headerData | No | The request's headers. | |
| dataOptions | No | Additional options for the request body data. | |
| description | No | The request's description. | |
| queryParams | No | The request's query parameters. | |
| rawModeData | No | The request body's raw mode data. | |
| collectionId | Yes | The collection's ID. | |
| graphqlModeData | No | The request body's GraphQL mode data. |