Update an API
PUT https://api.getpostman.com/apis/{{apiId}}
This call updates an existing API .
Request body should contain an api
object which should have the fields to be updated. Only name
, summary
and description
fields can be edited for an API.
Response contains an api
object with all the details related to the created API, namely, id
, name
, summary
, description
etc.
Requires API Key as
X-Api-Key
request header orapikey
URL query parameter.
Request Body
{"api"=>{"name"=>"New name", "description"=>"This is an updated Description"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"api":{"id":"387c2863-6ee3-4a56-8210-225f774edade","name":"Sync API","summary":"This is a summary","description":"This is a description.","createdBy":"5665","createdAt":"2019-02-12 19:34:49","updatedAt":"2019-02-12 19:34:49"}}