API Reference

Update category

put
http://dash.readme.local:3000/api/v1/categories/

Change the properties of a category.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the the category "Getting Started", enter the slug "getting-started"

Body Params
string

A short title for the category. This is what will show in the sidebar.

string
enum
Defaults to guide

A category can be part of your reference or guide documentation, which is determined by this field.

Allowed:
Responses
200

The category has successfully been updated

Updated about 4 years ago

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

Updated about 4 years ago