Logo
30-day challenge API Documentation

Update an API release

PATCH https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/releases/{{apiReleaseId}}

This endpoint is deprecated in Qodex v10 and higher.

Updates an API version's release. Include at least one of the following properties in the release object:

  • name — A string value that contains the release name.
  • visibility — A string value that contains the release's visibility. One of:
    • private — The release is private.
    • public — The release is public.
  • summary — A string value that contains the release's summary.
  • description — A string value that contains the release's description.
  • gitTag — A string value that contains a valid Git tag ID. The tag must exist in the API's connected Git repository.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "release": { "id": "8d7ba74e-2c36-4e36-a263-f3c0c9ae21d2", "name": "Release 1.5", "summary": "This is the first public release update.", "description": "This is the first release update of the Test API. For more information, read the documentation.", "visibility": "public", "gitTag": "Test" } }



Curl
curl -X PATCH 'https://api.getpostman.com/apis/undefined/versions/undefined/releases/undefined' -d '{"release":{"name":"undefined","summary":"undefined","description":"undefined","visibility":"undefined","gitTag":"undefined"}}'

ENDPOINTS