Update a server response

PUT

/mocks/:mockId/server-responses/:serverResponseId

PUT

/mocks/:mockId/server-responses/:serverResponseId

$ curl -X PUT https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289/server-responses/965cdd16-fe22-4d96-a161-3d05490ac421 \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "serverResponse": {
>     "name": "Internal Server Error",
>     "statusCode": 500,
>     "headers": [
>       {
>         "key": "Content-Type",
>         "value": "application/json"
>       }
>     ],
>     "language": "json",
>     "body": "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
>   }
> }'

1 {
2   "createdAt": "2022-08-02T15:08:03.000Z",
3   "updatedAt": "2022-08-02T15:08:03.000Z",
4   "id": "965cdd16-fe22-4d96-a161-3d05490ac421",
5   "name": "Internal Server Error",
6   "statusCode": 500,
7   "headers": [
8     {
9       "key": "Content-Type",
10       "value": "application/json"
11     }
12   ],
13   "language": "json",
14   "body": "{\n    \"message\": \"Something went wrong; try again later.\"\n}",
15   "createdBy": "12345678",
16   "updatedBy": "12345678",
17   "mock": "32cd624d-9986-4f20-9048-89252f722269"
18 }

Updates a server response.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

mockIdstringRequired

The mock's ID.

serverResponseIdstringRequired

The server response's ID.

Request

This endpoint expects an object.

serverResponseobjectOptional

Response

Successful Response

createdAtdatetimeOptional

The date and time at which the server response was created.

updatedAtdatetimeOptional

The date and time at which the server response was last updated.

idstringOptional

The server response's ID.

namestringOptional

The server response's name.

statusCodedoubleOptional

The server response's 5xx HTTP response code.

headerslist of objectsOptional

The server response’s request headers key-value pairs, such as Content-Type, Accept, encoding, and other information.

languagestringOptional

The server response's body language type.

bodystringOptional

The server response's body that returns when calling the mock server.

createdBystringOptional

The user ID of the user who created the server response.

updatedBystringOptional

The user ID of the user who last updated the server response.

mockstringOptional

The associated mock server's ID.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error