Folders

Create folder

post
Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Body
pathstringRequired

Folder path to create. Slashes in the path are treated as folder separators.

Example: Parent/New Folder/
collectionIdstringOptional

Optional collection ID for a collection-scoped folder.

colorstringOptional

Optional folder color. Must be one of the colors configured in the client folder settings.

Example: primary
permsstring[] · max: 64Optional

Optional upload permissions to apply to the folder. Each permission should follow the structure users/{user ID}:{permission} or groups/{group ID}:{permission}.

Available permissions are:

  • get: can view
  • share: can share
  • update: can edit
  • *: full access

Use GET /v1/users or GET /v1/groups to find user or group IDs.

Note: Adding a group to the permission list of a folder grants users in that group the corresponding permission to all Assets inside the folder. See https://support.hivo.co/library/folder-management-tools/folder-permissions.

Example: users/abc123abc123abc12:*
Responses
chevron-right
201

Created

application/json
post
/v1/folders

Last updated