Logo
30-day challenge API Documentation

Update an API

PUT https://api.getpostman.com/apis/{{apiId}}

Updates an API. Include at least one of the following properties in the api object:

  • 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.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status OK

{ "api": { "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/undefined' -H 'Content-Type: application/json' -d '{"api":{"name":"undefined","summary":"undefined","description":"undefined"}}'

ENDPOINTS