API Reference
  1. ReadMe API
  2. Categories

Update a category

patch
https://api.readme.com/v2/branches//categories//

Update an existing category in your ReadMe project.

📘

This route is only available to projects that are using ReadMe Refactored.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required
^[a-z0-9][a-z0-9_-]{0,29}$
Defaults to guides

The section of your documentation where the category resides: guides, reference, or a guide section your project declares.

string
required

The category's name.

string
required
(v{0,1})(stable|\bmain(?:-[a-z]{2})?(?![\w.-])|([0-9]+)(?:\.([0-9]+))?(?:\.([0-9]+))?(-.*)?)(_(.*))?

Project version number, stable for your project's stable version, or a valid branch name.

Body Params
string

The category's name.

number

The position of the category in your project's sidebar.

Response

Updated 21 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading

Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago

Did this page help you?