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.

Request Body

{"name"=>"{{apiName}}", "summary"=>"{{apiSummary}}", "description"=>"{{apiDescription}}"}

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

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"}