Update a version

PUT {{baseUrl}}/apis/{{apiId}}/versions/{{apiVersionId}}

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

  • name — A string value that contains the version name.
  • releaseNotes — A string value that contains the Markdown-supported release notes.

Note:

This endpoint returns an HTTP 404 Not Found response when an API version is pending publication.

Request Body

{"name"=>"{{apiVersionName}}", "releaseNotes"=>"{{releaseNotes}}"}

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"createdAt":"2022-06-09T14:48:45.000Z","updatedAt":"2022-06-09T19:50:49.000Z","id":"8d7ba74e-2c36-4e36-a263-f3c0c9ae21d2","name":"Release 1.5","releaseNotes":"This is the first public release update."}