post/api/v1/docs-views/{spaceId}/remove

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}/remove
  • Auth: none declared

Path parameters

spaceIdinteger required

Space id, from GET /spaces.

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Request body

navItemIdinteger required
mode'unlist' | 'delete' required

unlist takes it out of the Docs view and keeps its files; delete also deletes its file or directory and every page under it.

confirmedArchiveboolean

For delete: whether you expect pages to be archived (synced Spaces) rather than deleted; a mismatch answers 409.

Response

Removed

mode'unlist' | 'delete' required
removedNavItemIdsinteger[] required
deletedFilesinteger required

Files and directories deleted from the Files view.

archivedDocumentIdsstring[] required
pendingRemovalDocumentIdsstring[] required

Synced pages that stay until a push removes them from GitHub.

Changes

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