Logo
15_Days_of_Postman_-_for_testers_IvanKo API Documentation

Update an API

PUT {{baseUrl}}/apis/{{apiId}}

Updates an API. Include at least one of the following properties in the request body:

  • name — A string value that contains the API's name.
  • summary — A string value that contains a summary of the API.
  • description — A string value that contains the description of the API. This supports Markdown formatting.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "createdAt": "2022-06-29T20:46:58.000Z", "updatedAt": "2022-06-29T20:46:58.000Z", "id": "5360b75f-447e-467c-9299-12fd6c92450d", "name": "Test API A", "summary": "Test API A Schema", "description": "This is Test API A.", "createdBy": "12345678", "updatedBy": "12345678" }



Curl
curl -X PUT 'https://api.getpostman.com/apis/apiId' -H 'Accept: application/vnd.api.v10+json' -d '{"name":"apiName","summary":"apiSummary","description":"apiDescription"}'

ENDPOINTS