OMomniapp
Folders

Create a folder

Changed on
post/api/v1/folders

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/folders
  • Auth
    HTTP bearer

Request body

breadcrumbRootboolean

When true, breadcrumbs for content in this folder start at this folder, hiding parent folders

namestring required

Name of the folder to create

parentFolderIdstring uuid

Parent folder ID (omit to create at root level)

scope'organization' | 'restricted'

Share scope for the folder

userIdstring uuid

User ID to create the folder as (for org-scoped API keys only)

Example request

{
  "name": "My New Folder"
}

Response

Folder created successfully

breadcrumbRootboolean required

Whether breadcrumbs start at this folder

idstring uuid required

ID of the created folder

namestring required

Name of the created folder

ownerIdstring uuid required

User ID of the folder owner

pathstring required

Full path to the folder

scope'organization' | 'restricted' required

Share scope of the folder

Changes

  • f65b6ea0a62fRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status