Create a response

POST

/collections/:collectionId/responses

POST

/collections/:collectionId/responses

curl -X POST "https://api.postman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/responses?request=c82dd02c-4870-4907-8fcb-593a876cf05b" \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Example GET Response",
  "headers": [
    {
      "key": "content-type",
      "value": "application/json; charset=utf-8"
    },
    {
      "key": "content-length",
      "value": "370"
    },
    {
      "key": "etag",
      "value": "W/\"172-GDbDAS2r5X4Ypw2ia9AUhtyIyhk\""
    },
    {
      "key": "set-cookie",
      "value": "sails.sid=s%3A23szD8Az12345Vs7dMzU4hjUHqqA1LeX.x8Jbnx4BEVHgzajknZdH%2BqxW7Pctx47m%2FlduU5Q4TAI; Path=/ HttpOnly"
    }
  ],
  "responseCode": {
    "code": 200,
    "name": "OK"
  },
  "text": "{\n  \"args\": {\n    \"param\": \"value\"\n  },\n  \"headers\": {\n    \"x-forwarded-proto\": \"https\",\n    \"x-forwarded-port\": \"443\",\n    \"host\": \"postman-echo.com\",\n    \"x-amzn-trace-id\": \"Root=1-64f9cd12-62f18f3a048796d345508073\",\n    \"user-agent\": \"curl/7.88.1\",\n    \"accept\": \"*/*\",\n    \"content-type\": \"application/json\"\n  },\n  \"url\": \"https://postman-echo.com/get?param=value\"\n}\n",
  "language": "json",
  "requestObject": "{\n  \"name\": \"Request\",\n  \"description\": \"\",\n  \"url\": \"https://postman-echo.com/get?param=value\",\n  \"method\": \"GET\",\n  \"headers\": [\n    {\n      \"key\": \"Host\",\n      \"value\": \"postman-echo.com\"\n    },\n    {\n      \"key\": \"user-agent\",\n      \"value\": \"curl/7.88.1\"\n    },\n    {\n      \"key\": \"accept\",\n      \"value\": \"*/*\"\n    },\n    {\n      \"key\": \"content-type\",\n      \"value\": \"application/json\"\n    }\n  ],\n  \"dataMode\": \"raw\",\n  \"rawModeData\": null,\n  \"dataOptions\": {\n    \"raw\": {\n      \"language\": \"json\"\n    }\n  }\n}"
}'

{
  "data": {
    "id": "cc364734-7dfd-4bfc-897d-be763dcdbb07",
    "owner": "12345678",
    "request": "c82dd02c-4870-4907-8fcb-593a876cf05b",
    "createdAt": "2023-09-07T13:33:18.700Z",
    "updatedAt": "2023-09-07T13:33:18.700Z",
    "lastUpdatedBy": "12345678",
    "headers": [
      {
        "key": "content-type",
        "value": "application/json; charset=utf-8"
      },
      {
        "key": "content-length",
        "value": "370"
      },
      {
        "key": "etag",
        "value": "W/\"172-GDbDAS2r5X4Ypw2ia9AUhtyIyhk\""
      },
      {
        "key": "set-cookie",
        "value": "sails.sid=s%3A23szD8Az12345Vs7dMzU4hjUHqqA1LeX.x8Jbnx4BEVHgzajknZdH%2BqxW7Pctx47m%2FlduU5Q4TAI; Path=/ HttpOnly"
      }
    ],
    "language": "json",
    "name": "Example GET Response",
    "requestObject": "{\n  \"name\": \"Request\",\n  \"description\": \"\",\n  \"url\": \"https://postman-echo.com/get?param=value\",\n  \"method\": \"GET\",\n  \"headers\": [\n    {\n      \"key\": \"Host\",\n      \"value\": \"postman-echo.com\"\n    },\n    {\n      \"key\": \"user-agent\",\n      \"value\": \"curl/7.88.1\"\n    },\n    {\n      \"key\": \"accept\",\n      \"value\": \"*/*\"\n    },\n    {\n      \"key\": \"content-type\",\n      \"value\": \"application/json\"\n    }\n  ],\n  \"dataMode\": \"raw\",\n  \"rawModeData\": null,\n  \"dataOptions\": {\n    \"raw\": {\n      \"language\": \"json\"\n    }\n  }\n}",
    "responseCode": {
      "code": 200,
      "name": "OK"
    },
    "text": "{\n  \"args\": {\n    \"param\": \"value\"\n  },\n  \"headers\": {\n    \"x-forwarded-proto\": \"https\",\n    \"x-forwarded-port\": \"443\",\n    \"host\": \"postman-echo.com\",\n    \"x-amzn-trace-id\": \"Root=1-64f9cd12-62f18f3a048796d345508073\",\n    \"user-agent\": \"curl/7.88.1\",\n    \"accept\": \"*/*\",\n    \"content-type\": \"application/json\"\n  },\n  \"url\": \"https://postman-echo.com/get?param=value\"\n}\n"
  },
  "meta": {
    "action": "create",
    "model": "response"
  },
  "model_id": "cc364734-7dfd-4bfc-897d-be763dcdbb07",
  "revision": 32456338262
}

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

collectionIdstringRequired

The collection's ID.

Query parameters

requeststringRequired

The parent request's ID.

Request

This endpoint expects an object.

namestringOptional

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.

descriptionstring or nullOptional

The response's description.

urlstring or nullOptional

The associated request's URL.

methodenumOptional

The associated request's HTTP method.

headerslist of objectsOptional

The response's headers.

dataModeenumOptional

The associated request body's data mode.

Allowed values:

rawModeDatastring or nullOptional

The associated request body's raw mode data.

dataOptionsobjectOptional

Additional options for the associated request body data.

responseCodeobjectOptional

The response's HTTP response code information.

statusstring or nullOptional

The response's HTTP status text.

timestringOptional

The time taken by the request to complete, in milliseconds.

cookiesstring or nullOptional

The response's cookie data.

mimestring or nullOptional

The response's MIME type.

textstringOptional

The raw text of the response body.

languagestringOptional

The response body's language type.

rawDataTypestring or nullOptional

The response's raw data type.

requestObjectstringOptional

A JSON-stringified representation of the associated request.

Response

Successful Response

dataobjectOptional

Information about the response. For a complete list of properties, refer to the Response 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 response'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