Update a response

PUT

/collections/:collectionId/responses/:responseId

PUT

/collections/:collectionId/responses/:responseId

$ curl -X PUT https://api.getpostman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/responses/cc364734-7dfd-4bfc-897d-be763dcdbb07 \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Example Response",
>   "headers": [
>     {
>       "key": "Date",
>       "value": "Fri, 01 Sep 2023 07:36:18 GMT"
>     },
>     {
>       "key": "Content-Type",
>       "value": "application/json; charset=utf-8"
>     },
>     {
>       "key": "Content-Length",
>       "value": "607"
>     },
>     {
>       "key": "Connection",
>       "value": "keep-alive"
>     }
>   ],
>   "responseCode": {
>     "code": 200,
>     "name": "OK"
>   },
>   "status": null,
>   "time": "50",
>   "cookies": null,
>   "mime": null,
>   "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-64f9cd12-62f18f3a048796d345508073\",\n        \"content-length\": \"24\",\n        \"content-type\": \"application/json\",\n        \"x-api-key\": \"xxx\",\n        \"user-agent\": \"PostmanRuntime/7.32.3\",\n        \"accept\": \"*/*\",\n        \"postman-token\": \"XXX\",\n        \"accept-encoding\": \"gzip, deflate, br\"\n    },\n    \"json\": {\n        \"field\": \"Value\"\n    },\n    \"url\": \"https://postman-echo.com/post\"\n}",
>   "language": "json",
>   "rawDataType": null,
>   "requestObject": "{\"data\":null,\"dataMode\":\"raw\",\"dataOptions\":{\"raw\":{\"language\":\"json\"}},\"headerData\":[],\"method\":\"POST\",\"pathVariableData\":[],\"queryParams\":[],\"url\":\"https://postman-echo.com/post\",\"headers\":\"\",\"pathVariables\":{},\"protocolProfileBehavior\":{\"disableBodyPruning\":true},\"rawModeData\":\"{\\n    \\\"field\\\": \\\"Value\\\"\\n}\",\"graphqlModeData\":{}}",
>   "createdAt": "2023-09-01T09:29:54.000Z",
>   "lastRevision": 32368133468,
>   "lastUpdatedBy": "12345678",
>   "owner": "12345678",
>   "request": "c82dd02c-4870-4907-8fcb-593a876cf05b",
>   "updatedAt": "2023-09-01T09:29:54.000Z"
> }'

1 {
2   "data": {
3     "id": "c82dd02c-4870-4907-8fcb-593a876cf05b",
4     "name": "Example Response",
5     "owner": "12345678",
6     "createdAt": "2023-09-01T09:29:54.000Z",
7     "updatedAt": "2023-09-08T12:37:33.000Z",
8     "lastRevision": 32368133468,
9     "lastUpdatedBy": "12345678",
10     "cookies": null,
11     "headers": [
12       {
13         "key": "Date",
14         "value": "Fri, 01 Sep 2023 07:36:18 GMT"
15       },
16       {
17         "key": "Content-Type",
18         "value": "application/json; charset=utf-8"
19       },
20       {
21         "key": "Content-Length",
22         "value": "607"
23       },
24       {
25         "key": "Connection",
26         "value": "keep-alive"
27       }
28     ],
29     "language": "json",
30     "mime": null,
31     "rawDataType": null,
32     "request": "c82dd02c-4870-4907-8fcb-593a876cf05b",
33     "requestObject": "{\"data\":null,\"dataMode\":\"raw\",\"dataOptions\":{\"raw\":{\"language\":\"json\"}},\"headerData\":[],\"method\":\"POST\",\"pathVariableData\":[],\"queryParams\":[],\"url\":\"https://postman-echo.com/post\",\"headers\":\"\",\"pathVariables\":{},\"protocolProfileBehavior\":{\"disableBodyPruning\":true},\"rawModeData\":\"{\\n    \\\"field\\\": \\\"Value\\\"\\n}\",\"graphqlModeData\":{}}",
34     "responseCode": {
35       "code": 200,
36       "name": "OK"
37     },
38     "status": null,
39     "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-64f9cd12-62f18f3a048796d345508073\",\n        \"content-length\": \"24\",\n        \"content-type\": \"application/json\",\n        \"x-api-key\": \"xxx\",\n        \"user-agent\": \"PostmanRuntime/7.32.3\",\n        \"accept\": \"*/*\",\n        \"postman-token\": \"XXX\",\n        \"accept-encoding\": \"gzip, deflate, br\"\n    },\n    \"json\": {\n        \"field\": \"Value\"\n    },\n    \"url\": \"https://postman-echo.com/post\"\n}",
40     "time": "50"
41   },
42   "meta": {
43     "action": "update",
44     "model": "response"
45   },
46   "model_id": "c82dd02c-4870-4907-8fcb-593a876cf05b",
47   "revision": 32473225008
48 }

Updates a response in a collection. For a complete list of properties, see the Postman Collection Format documentation.

Note:

You must pass a collection ID (12ece9e1-2abf-4edc-8e34-de66e74114d2), not a collection UID (12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2), in this endpoint.
This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the name property). The endpoint does not update the entire resource.

Updates a response in a collection. For a complete list of properties, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection UID (`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint. - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does not update the entire resource.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

responseIdstringRequired

The response's ID.

collectionIdstringRequired

The collection's ID.

Request

This endpoint expects an object.

namestringOptional

The response's name.

descriptionstring or nullOptional

The response's description.

urlstring or nullOptional

The associated request's URL.

methodenumOptional

The request's HTTP method.

headerslist of objectsOptional

A list of headers.

dataModeenumOptional

The associated request body's data mode.

rawModeDatastring or nullOptional

The associated request body's raw mode data.

dataOptionsobjectOptional

Additional configurations and options set for the request body's various data modes.

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

dataobject

Information about the updated response. For a complete list of response properties, refer to the Response entry in the Postman Collection Format documentation.

metamap from strings to any

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

model_idstring

The response's ID.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error