folders

Rename, move and/or restyle a folder.

Renames the folder, moves it to a new parent and/or restyles it. parentId: null moves it to root; an absent parentId leaves the parent unchanged. icon/tint set the nav glyph and tint; null resets one to its default and an absent key leaves it unchanged. Moving carries the folder's whole subtree; a move into the folder's own subtree is rejected (409 folder-cycle). Requires the folder's current version (optimistic concurrency). Editor or above.

patch/v1/folders/{id}

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/folders/{id}
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

versioninteger required
namestring
parentIdstring uuid nullable

New parent, or null for root. Omit to keep the current parent.

icon'folder' | 'chart' | 'trend' | 'pie' | 'dollar' | 'wallet' | 'truck' | 'box' | 'warehouse' | 'pin' | 'globe' | 'users' | 'target' | 'flag' | 'star' | 'shield' | 'clipboard' | 'calendar' | 'clock' | 'bolt' | 'gear' | 'briefcase' | 'megaphone' | 'book' nullable

Nav icon key. null resets to the default glyph; omit to keep the current icon.

tint'slate' | 'teal' | 'indigo' | 'sea' | 'navy' | 'periwinkle' | 'violet' | 'steel' nullable

Nav tint key. null resets to the default (slate); omit to keep the current tint.

Response

The updated folder (version incremented).

Changes

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