Create a request

POST

/collections/:collectionId/requests

POST

/collections/:collectionId/requests

curl -X POST https://api.postman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Example GET Request",
  "description": "This is an example GET request.",
  "method": "GET",
  "url": "https://postman-echo.com/get?param=value",
  "queryParams": [
    {
      "key": "id",
      "value": "{{id}}",
      "description": "Optional. The user'\''s ID.",
      "enabled": true,
      "equals": true
    }
  ],
  "dataMode": "raw",
  "rawModeData": null,
  "dataOptions": {
    "raw": {
      "language": "json"
    }
  },
  "headers": [
    {
      "key": "Host",
      "value": "postman-echo.com"
    },
    {
      "key": "user-agent",
      "value": "curl/7.88.1"
    },
    {
      "key": "accept",
      "value": "*/*"
    },
    {
      "key": "content-type",
      "value": "application/json"
    }
  ]
}'

{
  "data": {
    "id": "c82dd02c-4870-4907-8fcb-593a876cf05b",
    "name": "Example GET Request",
    "owner": "12345678",
    "folder": null,
    "responses": [],
    "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
    "responses_order": [],
    "createdAt": "2023-09-07T13:33:17.912Z",
    "updatedAt": "2023-09-07T13:33:17.912Z",
    "lastUpdatedBy": "12345678",
    "dataMode": "raw",
    "dataOptions": {
      "raw": {
        "language": "json"
      }
    },
    "description": "This is an example GET request.",
    "headerData": [],
    "headers": [
      {
        "key": "Host",
        "value": "postman-echo.com"
      },
      {
        "key": "user-agent",
        "value": "curl/7.88.1"
      },
      {
        "key": "accept",
        "value": "*/*"
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "method": "GET",
    "queryParams": [
      {
        "description": "Optional. The user's ID.",
        "enabled": true,
        "equals": true,
        "key": "id",
        "value": "{{id}}"
      }
    ],
    "rawModeData": null,
    "url": "https://postman-echo.com/get?param=value"
  },
  "meta": {
    "action": "import",
    "model": "request"
  },
  "model_id": "c82dd02c-4870-4907-8fcb-593a876cf05b",
  "revision": 32456338071
}

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

collectionIdstringRequired

The collection's ID.

Query parameters

folderstringOptional

The folder ID in which to create the request. By default, the system creates the request at the collection level.

Request

This endpoint expects an object.

namestringOptional

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.

descriptionstring or nullOptional

The request's description.

methodenumOptional

The request's HTTP method.

urlstring or nullOptional

The request's URL.

headerDatalist of objectsOptional

The request's headers.

queryParamslist of objectsOptional

The request's query parameters.

dataModeenumOptional

The request body's data mode.

Allowed values:

datalist of objectsOptional

The request body's form or urlencoded data.

rawModeDatastring or nullOptional

The request body's raw mode data.

graphqlModeDataobjectOptional

The request body's GraphQL mode data.

dataOptionsobjectOptional

Additional options for the request body data.

authobjectOptional

The request's authorization settings.

eventslist of objectsOptional

The request’s pre-request and test scripts.

Response

Successful Response

dataobjectOptional

Information about the created request. For a complete list of properties, refer to the Request entry in the Postman Collection Format documentation.

metamap from strings to anyOptional

A Postman-specific response that contains information about the internal performed operation.

model_idstringOptional

The request's ID.

revisiondoubleOptional

An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error