patch/api/v1/docs-views/{spaceId}/items/{navItemId}

Request

  • Base URL: https://falconer.com (the document declares no server; this is the origin it was published from)
  • URL: https://falconer.com/api/v1/docs-views/{spaceId}/items/{navItemId}
  • Auth: none declared

Path parameters

spaceIdinteger required

Space id, from GET /spaces.

navItemIdinteger required

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Request body

titlestring

A container's title. A page's title is its first heading; change it with PUT /docs/{id}.

fileNamestring

Renames the file or directory behind the item in place, such as getting-started.mdx. Its folder stays the same.

kind'group' | 'tab' | 'dropdown' | 'anchor' | 'link'

How a folder inside a public docs site renders. Requires site management; tab only directly under the site root.

access'public' | 'private' nullable

null clears it so the container inherits again.

hiddenboolean

Response

Item updated

navItemIdinteger required
pathstring nullable required

The item's file or directory in the Files view, if any.

Changes

No recorded changes to this operation across all 1 revision of this API.