Customer StoriesReadMe Blog
API Reference
Start typing to search…

Update version

put
https://dash.readme.com/api/v1/version/

Update an existing version.

❗

API v1 and this route are not available to projects that are using ReadMe Refactored. Check out our API migration guide for information on how to migrate to the new API.

Path Params
string
required

Semver identifier for the project version. For best results, use the formatted version_clean value listed in the response from the Get Versions endpoint.

Body Params
string
required

Semantic Version

string

Dubbed name of version.

string
required

Semantic Version to use as the base fork.

boolean

Should this be the main version?

boolean
Defaults to true
boolean

Should this be publically accessible?

boolean

Should this be deprecated? Only allowed in PUT operations.

string

Status of pdf generations.

Responses
200

The version was successfully updated.

Updated 9 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago