API Reference

Update custom page

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

Update a custom page with this slug.

❗

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.

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 page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title "Getting Started", enter the slug "getting-started".

Body Params
string
required

Title of the custom page.

string

Body formatted in Markdown (displayed by default).

string

Body formatted in HTML (sanitized, only displayed if htmlmode is true).

boolean
Defaults to false

true if html should be displayed, false if body should be displayed.

boolean
Defaults to true

Visibility of the custom page.

Responses
200

The custom page was successfully updated.

Updated about 1 month 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 1 month ago