Skip to content

UpdateFolderInput ​

Type: Input

Input for updateFolder. A patch: every field except id is optional, and an omitted (null) field keeps its stored value rather than clearing it.

Fields ​

NameTypeDefaultDescription
controllerIdControllerIDTypeID of the edge controller to bind to (e.g. "ctl_01K…"), used when the resulting kind is CONTROLLER. Omit (null) to keep the currently bound controller. Must name a controller in this tenant.
descriptionStringNew description (max 1000 characters). Omit (null) to leave the stored description unchanged; null does NOT clear it.
idFolderID!TypeID of the folder to update (e.g. "fld_01K…"). The only required field.
isDefaultBooleanPromote this folder to the tenant default. Omit (null) to keep the stored flag. Passing false on the current default is rejected — a tenant must always have exactly one default; promote another folder instead.
kindFolderBindingKindNew binding kind. Omit (null) to keep the current binding wholesale. Supplying the current kind without a new reference ID keeps the current reference. Rebinding is rejected if any file already references this folder.
nameStringNew folder name; must stay unique within the tenant. Omit (null) to leave the stored name unchanged — an update that doesn't rename need not resend it.
rootPathStringNew root path/prefix, normalized and validated for the resulting binding as on create. Omit (null) to keep the stored root path. Changing it is rejected if any file already references this folder, since stored file handles would resolve against the wrong prefix.
storageBackendIdStorageBackendIDTypeID of the storage backend to bind to (e.g. "sbk_01K…"), used when the resulting kind is STORAGE_BACKEND. Omit (null) to keep the currently bound backend. Must name a backend in this tenant.

Connect machines, automate workflows, and build custom apps for print production.