15_Days_of_Postman_-_for_testers_IvanKo API Documentation
Create a response
POST {{baseUrl}}/collections/{{collectionId}}/responses?request=<string>
Creates a request response in a collection. For a complete list of properties, see the [Collection Format Response 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.
Body
PARAM
| Key | Datatype | Required | Description |
request
|
string | (Required) The parent request's ID. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"model_id": "cc364734-7dfd-4bfc-897d-be763dcdbb07",
"meta": {
"model": "response",
"action": "create"
},
"data": {
"request": "c82dd02c-4870-4907-8fcb-593a876cf05b",
"responseCode": {
"code": 200,
"name": "OK"
},
"requestObject": "{\n \"name\": \"Request\",\n \"description\": \"\",\n \"url\": \"https://postman-echo.com/post\",\n \"method\": \"POST\",\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 \"key\": \"content-length\",\n \"value\": \"22\"\n }\n ],\n \"dataMode\": \"raw\",\n \"rawModeData\": null,\n \"dataOptions\": {\n \"raw\": {\n \"language\": \"json\"\n }\n }\n}",
"text": "{\n \"args\": {},\n \"data\": {\n \"field\": \"Value\"\n },\n \"files\": {},\n \"form\": {},\n \"headers\": {\n \"x-forwarded-proto\": \"https\",\n \"x-forwarded-port\": \"443\",\n \"host\": \"postman-echo.com\",\n \"x-amzn-trace-id\": \"Root=1-71bdd0e4-2ad8-45ab-be3c-3dde999711a6\",\n \"content-length\": \"22\",\n \"user-agent\": \"curl/7.88.1\",\n \"accept\": \"*/*\",\n \"content-type\": \"application/json\"\n },\n \"json\": {\n \"field\": \"Value\"\n },\n \"url\": \"https://postman-echo.com/post\"\n}\n",
"name": "POST response",
"language": "json",
"headers": [
{
"key": "date",
"value": "Thu, 07 Sep 2023 12:41:59 GMT"
},
{
"key": "content-type",
"value": "application/json; charset=utf-8"
},
{
"key": "content-length",
"value": "468"
},
{
"key": "etag",
"value": "W/\"1d4-JuAIw8ssoFCtGzk/UwITxaiSbrc\""
},
{
"key": "set-cookie",
"value": "sails.sid=s%3A23szD8Az12345Vs7dMzU4hjUHqqA1LeX.x8Jbnx4BEVHgzajknZdH%2BqxW7Pctx47m%2FlduU5Q4TAI; Path=/ HttpOnly"
}
],
"id": "cc364734-7dfd-4bfc-897d-be763dcdbb07",
"owner": "12345678",
"lastUpdatedBy": "12345678",
"createdAt": "2023-09-07T13:35:34.817Z",
"updatedAt": "2023-09-07T13:35:34.817Z"
},
"revision": 32456382761
} |
Curl
curl -X POST 'https://api.getpostman.com/collections/collectionId/responses?request=<string>?request=<string>' -d '{"name":"responseName"}'
ENDPOINTS